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

Standardize GitHub Milestones for Website #201

Closed
austinlparker opened this issue Oct 1, 2019 · 2 comments

Comments

@austinlparker
Copy link
Member

@austinlparker austinlparker commented Oct 1, 2019

The OpenTelemetry website will be updating shortly (see open-telemetry/opentelemetry.io#30 for more details) with a new feature, an automatically generated SIG progress chart. This chart is generated automatically when the site is published, using data from the GitHub API.

For existing SIGs
In order for each SIG's progress to be accurately reported, each SIG needs to create milestones that match the progress labels in the chart config. Each SIG should create milestones with the following names (note that the label can be a substring of the milestone name):

  • v0.1
  • v0.2
  • v0.3
  • v0.4
  • beta
  • rc
  • v1.0

Once a milestone is completed (by that version releasing), the milestone should be closed.

For new SIGs
If a SIG is being created that wants to add its progress to the chart, the following steps should be taken:

  • In the website repository, make a PR that modifies data/progress_source.yaml and adds a new entry to the data collection in that file.
  • Be sure to follow the format of the other entries exactly - the sourceUrl and label fields are of special note. The sourceUrl should be in the same format (https://github.com/open-telemetry/<repo_name>) as the others. The label field will be used exactly as written as the row label in the chart.

If you find any issues with the chart, please open an issue in the website repository. Maintainers, please use this issue to ask any questions about creating the milestones. Thanks in advance everyone!

@austinlparker

This comment has been minimized.

Copy link
Member Author

@austinlparker austinlparker commented Nov 1, 2019

The OpenTelemetry website recently updated with a new feature to pull release notes from GitHub for the latest release from each SIG. If you would like to use this feature, please ensure that you are publishing releases + release notes through GitHub Releases.

@SergeyKanzhelev

This comment has been minimized.

Copy link
Contributor

@SergeyKanzhelev SergeyKanzhelev commented Dec 5, 2019

I believe this needs to be worked out with individual repositories and maintainers. Happy to provide support in terms of pointing that this is very important.

Closing it here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.