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

Eel Baseline Version Bump to v1 #641

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

mdueltgen
Copy link
Collaborator

πŸ—£ Description

Bumping version number to be ready for Eel release and be consitent with ScubaGear

πŸ’­ Motivation and context

Closes #632

πŸ§ͺ Testing

N/A

βœ… Pre-approval checklist

  • This PR has an informative and human-readable title.
  • Changes are limited to a single goal - eschew scope creep!
  • If applicable, All future TODOs are captured in issues, which are referenced in the PR description.
  • The relevant issues PR resolves are linked preferably via closing keywords.
  • All relevant type-of-change labels have been added.
  • I have read and agree to the CONTRIBUTING.md document.
  • These code changes follow cisagov code standards.
  • All relevant repo and/or project documentation has been updated to reflect the changes in this PR.
  • Tests have been added and/or modified to cover the changes in this PR.
  • All new and existing tests pass.

βœ… Pre-merge Checklist

  • This PR has been smoke tested to ensure main is in a functional state when this PR is merged.
  • Squash all commits into one PR level commit using the Squash and merge button.

βœ… Post-merge Checklist

  • Delete the branch to clean up.
  • Close issues resolved by this PR if the closing keywords did not activate.

@mdueltgen mdueltgen added version bump This issue or pull request increments the version number Baseline Revision Medium eel labels Mar 11, 2025
@mdueltgen mdueltgen added this to the Eel milestone Mar 11, 2025
@mdueltgen mdueltgen self-assigned this Mar 11, 2025
@mdueltgen mdueltgen linked an issue Mar 11, 2025 that may be closed by this pull request
2 tasks
@mdueltgen mdueltgen requested a review from snarve March 11, 2025 16:34
Copy link
Collaborator

@snarve snarve left a comment

Choose a reason for hiding this comment

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

The updates in the baselines and the drift rules look good, however this will require code changes as well. The current change breaks the code. Do we plan to address that in this issue itself or will create a separate issue that will need a quick fix to avoid breaking code changes.
The breaking change is due to the format change in the version numbering from v0.4.x to v1 (code expects .separated version number)

image

image

@rlxdev rlxdev force-pushed the 632-update-baseline-policy-version-to-v1 branch from e757b52 to 34b8179 Compare March 11, 2025 17:26
@rlxdev
Copy link
Collaborator

rlxdev commented Mar 11, 2025

I quickly updated this to include the minor version, which is still what we want to do, right?

@snarve
Copy link
Collaborator

snarve commented Mar 11, 2025

I quickly updated this to include the minor version, which is still what we want to do, right?

Post v1, the baseline numbering will be different, which means each baseline number will be updated only if the baseline has been updated (there are restrictions on this as well, meaning which updates call for a change in the numbering). This is to be consistent with ScubaGear/M365 Baselines.

So, say Chat policy CHAT.1.1v1 if updated and requires a numbering update, will become CHAT.1.1v1.1. However, CHAT.1.2v1 will remain unchanged if there are no updates.

@rlxdev
Copy link
Collaborator

rlxdev commented Mar 11, 2025

So, if we're at a "major" version release, the baselines get no minor version number, but if they happen to change during a "point" release, they get a major and minor version number? This will require code changes (not major), but I'm wondering what the benefit is to having some baselines v1, v2, v3, and v1.3, v2.5, and not v1.0, v1.1, v1.2.

@rlxdev rlxdev force-pushed the 632-update-baseline-policy-version-to-v1 branch from 34b8179 to e757b52 Compare March 11, 2025 18:02
@adhilto
Copy link
Collaborator

adhilto commented Mar 11, 2025

So, if we're at a "major" version release, the baselines get no minor version number, but if they happen to change during a "point" release, they get a major and minor version number? This will require code changes (not major), but I'm wondering what the benefit is to having some baselines v1, v2, v3, and v1.3, v2.5, and not v1.0, v1.1, v1.2.

Actually, the control versions will never have minor versions. So in the example @snarve gave, the new version would be GWS.CHAT.1.1v2.

For example:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Baseline Revision eel Medium version bump This issue or pull request increments the version number
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update baseline policy version to v1
4 participants