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

fix: release info in docs #1794

Merged
merged 6 commits into from
Jan 17, 2025
Merged

fix: release info in docs #1794

merged 6 commits into from
Jan 17, 2025

Conversation

degenaro
Copy link
Collaborator

@degenaro degenaro commented Jan 8, 2025

Types of changes

  • Hot fix (emergency fix and release)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Documentation (change which affects the documentation site)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Release (develop -> main)

Quality assurance (all should be covered).

  • My code follows the code style of this project.
  • Documentation for my change is up to date?
  • My PR meets testing requirements.
  • All new and existing tests passed.
  • All commits are signed-off.

Summary

Key links:

Before you merge

  • Ensure it is a 'squash commit' if not a release.
  • Ensure CI is currently passing
  • Check sonar. If you are working for a fork a maintainer will reach out, if required.

Signed-off-by: Lou DeGenaro <[email protected]>
@degenaro degenaro requested a review from a team as a code owner January 8, 2025 19:06
@degenaro degenaro changed the title fix: release info in docs. fix: release info in docs Jan 8, 2025
@degenaro
Copy link
Collaborator Author

degenaro commented Jan 8, 2025

Fixes #1793

@degenaro degenaro self-assigned this Jan 8, 2025
@degenaro degenaro added this to the v3.7.0 milestone Jan 8, 2025
@degenaro degenaro added the documentation Improvements or additions to documentation label Jan 8, 2025
Copy link
Member

@jpower432 jpower432 left a comment

Choose a reason for hiding this comment

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

LGTM

@jpower432 jpower432 modified the milestones: v3.7.0, v3.8.0 Jan 14, 2025
Copy link
Collaborator

@vikas-agarwal76 vikas-agarwal76 left a comment

Choose a reason for hiding this comment

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

Minor comment

```
trestle 3.x => OSCAL 1.1.2
trestle 2.x => OSCAL 1.0.4
trestle 1.x => OSCAL 1.0.2
Copy link
Collaborator

Choose a reason for hiding this comment

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

We can also add
trestle 0.37.x => OSCAL 1.0.0

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

ok

@@ -148,7 +148,7 @@ This command will return the current version of Trestle and OSCAL it is using.

Running `trestle version` will return:

> Trestle version v2.0.0 based on OSCAL version 1.0.4
> Trestle version v3.6.0 based on OSCAL version 1.1.2

Copy link
Collaborator

Choose a reason for hiding this comment

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

Should we say Trestle version v3.x.x based on OSCAL version 1.1.2
else with every release we will also have to necessarily update this.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

ok

docs/index.md Outdated
@@ -44,7 +44,7 @@ Below shows trestle versions correspondence with OSCAL versions:
trestle 3.x => OSCAL 1.1.2
trestle 2.x => OSCAL 1.0.4
trestle 1.x => OSCAL 1.0.2
trestle 0.x => OSCAL 1.0.0
trestle 0.3.7 => OSCAL 1.0.0
Copy link
Collaborator

Choose a reason for hiding this comment

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

it is trestle 0.37.x

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Oops. Fixed.

Signed-off-by: Lou DeGenaro <[email protected]>
Copy link
Collaborator

@vikas-agarwal76 vikas-agarwal76 left a comment

Choose a reason for hiding this comment

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

LGTM

@degenaro degenaro merged commit bdb6444 into develop Jan 17, 2025
14 checks passed
@degenaro degenaro deleted the fix/docs-oscal-version branch January 17, 2025 11:45
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.

3 participants