Skip to content

Conversation

reubenmiller
Copy link
Contributor

@reubenmiller reubenmiller commented Jun 11, 2024

Proposed changes

Update the internal release process description and include more helpful instructions which provide links to the appropriate workflows, pull requests etc.

The manual step of updating the search index (related to the search function provide by Algolia) was also removed and added as a note to the tedge-docs step.

Note: the accuracy of these instructions won't be able to be verified in this PR, however it will be used in the next release to verify that it describes the process enough for any team member to publish a new release.

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Improvement (general improvements like code refactoring that doesn't explicitly fix a bug or add any new functionality)
  • Documentation Update (if none of the other choices apply)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Paste Link to the issue


Checklist

  • I have read the CONTRIBUTING doc
  • I have signed the CLA (in all commits with git commit -s)
  • I ran cargo fmt as mentioned in CODING_GUIDELINES
  • I used cargo clippy as mentioned in CODING_GUIDELINES
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Further comments

@reubenmiller reubenmiller added the documentation Improvements or additions to documentation label Jun 11, 2024
Signed-off-by: Reuben Miller <reuben.d.miller@gmail.com>
Copy link
Contributor

github-actions bot commented Jun 11, 2024

Robot Results

✅ Passed ❌ Failed ⏭️ Skipped Total Pass % ⏱️ Duration
452 0 3 452 100 1h18m45.695331s

Copy link
Contributor

@didier-wenzek didier-wenzek left a comment

Choose a reason for hiding this comment

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

Approved. A clear process to follow. We might have to improve this doc after the next release, but I feel confident!

@reubenmiller reubenmiller added this pull request to the merge queue Jun 11, 2024
Merged via the queue into thin-edge:main with commit 69df312 Jun 11, 2024
@reubenmiller reubenmiller deleted the docs-internal-release-process branch July 18, 2024 13:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants