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

Remove version bump instruction from CONTRIBUTING.md #148

Closed
davidhaymond opened this issue Nov 30, 2022 · 3 comments · Fixed by #150
Closed

Remove version bump instruction from CONTRIBUTING.md #148

davidhaymond opened this issue Nov 30, 2022 · 3 comments · Fixed by #150

Comments

@davidhaymond
Copy link
Collaborator

If each PR bumps the version number independently, it will lead to merge conflicts. The version number should only be bumped by the maintainer when publishing a new release.

@adrianwells
Copy link
Collaborator

@davidhaymond seems reasonable. Wonder how it ties into #147 if at all?

@davidhaymond
Copy link
Collaborator Author

@adrianwells There's a few ways you could set it up, but my recommendation would be to configure GitHub Actions to publish to the PS Gallery when a new release is created in GitHub. The process would be the following:

  1. Merge any PRs and development branches you wish to include in the release. (This should probably be done regularly anyways.)
  2. Bump the version number in master according semantic versioning guidelines.
  3. Create an annotated tag and a release and add release notes. GitHub Actions automatically publishes the current state of the master branch to PS Gallery.

Of course, if you're planning on a minor release, you wouldn't want to merge any breaking changes until you're ready for a major release.

@CalebAlbers
Copy link
Contributor

+1 for semver on release and moving that out of the contribution guide. There are some nice tools like semantic-commit which can auto-infer semver, but given the most common external contributor for this repo is a fly-by IT person with a specific need, having them conform to specific commit syntax sounds like a potentially heavy requirement.

Also, given the release frequency, creating the release and having a GHA workflow triggered on release events is a pretty easy thing to do.

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 a pull request may close this issue.

3 participants