Skip to content

Conversation

@igaray
Copy link
Collaborator

@igaray igaray commented Apr 11, 2023

Release process documentation

Description

  • Add RELEASE.md
  • Update pull request template to include an action item to update the changelog. This is now part of documentation process and PR acceptance criteria.
  • Update CHANGELOG.md to bring it back up to date.

Checklist

  • Linked to Github Issue
  • Unit tests added
  • Integration tests added.
  • This change requires new documentation.
    • Documentation has been added/updated.

@codecov
Copy link

codecov bot commented Apr 11, 2023

Codecov Report

Merging #959 (a85a935) into main (a1a65fd) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #959   +/-   ##
=======================================
  Coverage   97.74%   97.74%           
=======================================
  Files          74       74           
  Lines       30392    30392           
=======================================
  Hits        29708    29708           
  Misses        684      684           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@igaray igaray mentioned this pull request Apr 12, 2023
5 tasks
@igamigo
Copy link
Contributor

igamigo commented Apr 12, 2023

Probably not very useful (especially because it doesn't totally apply to releases), but here are some points that might be worth considering for the PR template:

  • Verified that related documentation/references are still valid (eg, if the project structure changes and a readme is moved, are references from the documentation in starknet-in-rust still valid?). We might want to communicate these changes to pertinent teams.
  • If dependencies are introduced/removed in a release, there might be some things that might have to be double checked (eg, is it no_std? is it cross-platform?). These are probably more related to the integration pipelines though.

@igaray igaray marked this pull request as ready for review April 13, 2023 22:14
@pefontana pefontana added this pull request to the merge queue Apr 14, 2023
Merged via the queue into main with commit a36797f Apr 14, 2023
@pefontana pefontana deleted the release_process branch April 14, 2023 20:21
kariy pushed a commit to dojoengine/cairo-rs that referenced this pull request Jun 23, 2023
* Initial release process document

* Added github release step

* Updated the godblessed changelog with the past two months of relevant PRs

* Address PR comments
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