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

Improve semantic versioning implementation #147

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

rob-luke
Copy link
Member

  • Modified the release procedure to include roles from the governance doc (which was created after the release procedure).
  • Modified the examples in the release procedure to be semantic version compliant.
  • Removed the "v" from the document to create a compliant version
  • Added "development" to the development version in the doc
    • This also helps users understand if they are looking at a released or development version

RELEASE.md Outdated
Comment on lines 8 to 10
2. Unanimous approval is required from the steering committee.
Ensure all steering committee members have explicitly given their approval as a public github comment in the issue.
4. Open a pull request that makes the following modifications:
Copy link
Collaborator

Choose a reason for hiding this comment

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

RELEASE.md Outdated
2. Unanimous approval is required from the steering committee.
Ensure all steering committee members have explicitly given their approval as a public github comment in the issue.
4. Open a pull request that makes the following modifications:
1. Modify the version number in the opening lines of the specification to match the version to be released (e.g., `1.0.0`).
Copy link
Collaborator

Choose a reason for hiding this comment

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

1!

Better a)?

addressing two comments made by @Horschig
Copy link
Collaborator

@dboas dboas left a comment

Choose a reason for hiding this comment

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

I addressed the two comments made by @Horschig
The rest looks good to me

Copy link
Collaborator

@samuelpowell samuelpowell left a comment

Choose a reason for hiding this comment

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

Current formatting does not render properly in Github Markdown (see guidance

3. Open a pull request that makes the following modifications:
1. Modify the version number in the opening lines of the specification to match the version to be released (e.g., `v1.0`).
a. Modify the version number in the opening lines of the specification to match the version to be released (e.g., `1.0.0`).
Copy link
Collaborator

Choose a reason for hiding this comment

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

Github is not parsing this markdown as a (sub-) bullet point, it appears inline in the preview text. Likely whitespace or numeral/character mix issue. This applies to all bullets below.

@samuelpowell
Copy link
Collaborator

Does CHANGELOG also need updating @rob-luke ?

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.

5 participants