Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update root readme to provide more clarity #13255

Merged
merged 14 commits into from
Aug 19, 2021

Conversation

ramya-rao-a
Copy link
Contributor

@ramya-rao-a ramya-rao-a commented Jan 15, 2021

This PR updates the root readme to

  • remove reference to "November" releases. This was added a year ago to refer to our first wave of releases
  • add more clarity on the different kinds of packages this repo houses
  • removes the difference between old and newer versions of the packages that follow the Azure SDK guidelines. For an end user that lands in the repo readme, it does not make a difference as to whether the package is Track 1 or Track 2. They would only care about what packages live here and what can they be used for

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Co-authored-by: Brian Terlson <brian.terlson@microsoft.com>
README.md Outdated Show resolved Hide resolved
ramya-rao-a and others added 2 commits January 15, 2021 11:54
Co-authored-by: Brian Terlson <brian.terlson@microsoft.com>
Copy link
Member

@xirzec xirzec left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the updates!

README.md Outdated Show resolved Hide resolved
Co-authored-by: Jeff Fisher <xirzec@xirzec.com>
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@check-enforcer
Copy link

This pull request is protected by Check Enforcer.

What is Check Enforcer?

Check Enforcer helps ensure all pull requests are covered by at least one check-run (typically an Azure Pipeline). When all check-runs associated with this pull request pass then Check Enforcer itself will pass.

Why am I getting this message?

You are getting this message because Check Enforcer did not detect any check-runs being associated with this pull request within five minutes. This may indicate that your pull request is not covered by any pipelines and so Check Enforcer is correctly blocking the pull request being merged.

What should I do now?

If the check-enforcer check-run is not passing and all other check-runs associated with this PR are passing (excluding license-cla) then you could try telling Check Enforcer to evaluate your pull request again. You can do this by adding a comment to this pull request as follows:
/check-enforcer evaluate
Typically evaulation only takes a few seconds. If you know that your pull request is not covered by a pipeline and this is expected you can override Check Enforcer using the following command:
/check-enforcer override
Note that using the override command triggers alerts so that follow-up investigations can occur (PRs still need to be approved as normal).

What if I am onboarding a new service?

Often, new services do not have validation pipelines associated with them, in order to bootstrap pipelines for a new service, you can issue the following command as a pull request comment:
/azp run prepare-pipelines
This will run a pipeline that analyzes the source tree and creates the pipelines necessary to build and validate your pull request. Once the pipeline has been created you can trigger the pipeline using the following comment:
/azp run js - [service] - ci

@ramya-rao-a
Copy link
Contributor Author

/check-enforcer override

@nickzhums
Copy link
Contributor

thanks for this change @ramya-rao-a looks good to me. One question - do we plan to re-organize other languages root readme like this as well?

@ramya-rao-a
Copy link
Contributor Author

do we plan to re-organize other languages root readme like this as well

I'll work with @lmazuel to make a similar update to the Python repo.
Python and TypeScript SDKs are in the same boat because all the Track 2 mgmt plane packages and most of the Track 1 data plane packages use the same package name as Track 1. So it is less relevant to differentiate between the two. I will leave it to @AlexGhiondea and @joshfree to decide whether .NET and Java repos want to follow the same format or not.

@nickzhums
Copy link
Contributor

@ramya-rao-a makes sense - thanks!

README.md Outdated Show resolved Hide resolved
@ramya-rao-a
Copy link
Contributor Author

/check-enforcer override

@ramya-rao-a ramya-rao-a merged commit badf61b into Azure:main Aug 19, 2021
ckairen pushed a commit to ckairen/azure-sdk-for-js that referenced this pull request Aug 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants