-
Notifications
You must be signed in to change notification settings - Fork 399
Add Versioning #520
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
Add Versioning #520
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| name: Monthly Tagging | ||
| on: | ||
| schedule: | ||
| # Run every month on the 1st day at 08:15 AM. | ||
| - cron: '15 8 * 1 *' | ||
|
|
||
| jobs: | ||
| create-monthly-tag: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Configure Git | ||
| run: | | ||
| git config user.name "${GITHUB_ACTOR}" | ||
| git config user.email "${GITHUB_ACTOR}@users.noreply.github.com" | ||
|
|
||
| - name: Get current year and week number | ||
| id: date | ||
| run: | | ||
| echo "tag_name=v0.0.$(date +%G%V)" >> "$GITHUB_OUTPUT" | ||
|
|
||
| - name: Create and push tag | ||
| run: | | ||
| TAG_NAME="${{ steps.date.outputs.tag_name }}" | ||
| # Create an annotated tag on the latest commit of the current branch (main) | ||
| git tag -a $TAG_NAME -m "$TAG_NAME" | ||
| # Push the newly created tag to the remote repository | ||
| git push origin $TAG_NAME | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should this also create GH releases? (if we do, we could also use the GitHub API to retrieve the last release number and increment that rather than use week numbers?)
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm not a fan of GH releases. They don't fit well with git and add some complexity. As the project does not provide artifacts in any way or release notes, I don't see the benefits of GH releases. Once the project becomes more stable, the use of GH releases should be reconsidered. But for the current development phase, it might be too much overhead. |
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| # Versioning Policy | ||
| This document outlines the versioning strategy for the OpenTelemetry eBPF Profiler project. | ||
|
|
||
| # Development Status | ||
| This project is currently under active development. As such, users should be aware that significant changes, including breaking API modifications, may occur at any time. | ||
|
|
||
| # Automatic Version Tagging | ||
| Automatic version tags are generated on a monthly basis to reflect ongoing development progress. | ||
|
|
||
| # Versioning Scheme | ||
| This project adheres to [Semantic Versioning 2](https://semver.org/spec/v2.0.0.html). | ||
|
|
||
| Major Version Zero (0.y.z): While the project is in its initial development phase, the major version will remain 0. Anything MAY change at any time. The public API SHOULD NOT be considered stable. Users are advised to exercise caution and expect potential breaking changes without prior notice during this phase. | ||
|
|
||
| # Automatic Tag Format | ||
| The format for automatically generated tags currently follows v0.0.x, where x represents the year followed by the week number. | ||
|
|
||
| ## Example: | ||
|
|
||
| - `v0.0.202501` would indicate the first week of 2025. | ||
|
|
||
| - `v0.0.202515` would indicate the fifteenth week of 2025. |
Uh oh!
There was an error while loading. Please reload this page.