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

Doc/release steps #53

Merged
merged 3 commits into from
Jun 30, 2022
Merged

Doc/release steps #53

merged 3 commits into from
Jun 30, 2022

Conversation

etagwerker
Copy link
Member

@etagwerker etagwerker commented Jun 30, 2022

  • Add an entry to CHANGELOG.md that links to this PR under the "main (unreleased)" heading.

Description:

Better documentation for contributing and releases.

This PR fixes #47

I will abide by the code of conduct.

This is no a direct copy as some things did not apply in the `next_rails` gem.
@etagwerker etagwerker requested a review from a team as a code owner June 30, 2022 13:18
@etagwerker etagwerker requested review from lubc and kindoflew and removed request for a team June 30, 2022 13:18
3. Commit your changes to a `release/v-1-1-0` branch
4. Push your changes and submit a pull request
5. Merge your pull request to the `main` branch
6. Git tag the latest version of the `main` branch (`git tag v1.1.0`)

Choose a reason for hiding this comment

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

Steps 6-9 can be replaced with bundle exec rake release

https://schneems.com/blogs/2016-03-18-bundler-release-tasks

Copy link
Member Author

Choose a reason for hiding this comment

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

@bronzdoc Is there official documentation for that task? The only documentation I can find online is that article, so I'm leaning towards keeping all the steps. Seasoned engineers will know that they can just rake release. 😄

@bronzdoc bronzdoc merged commit bae3861 into main Jun 30, 2022
@bronzdoc bronzdoc deleted the doc/release-steps branch June 30, 2022 17:52
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.

README doesn't include a Development section or Contributing section.
2 participants