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

Use catalog-info.yaml for release metadata. Get rid of openedx.yaml #526

Merged
merged 5 commits into from
Oct 3, 2023

Conversation

feanil
Copy link
Contributor

@feanil feanil commented Sep 28, 2023

OEP-55:ADR-4 in this PR has most of the context of what I'm proposing so I suggest reading that first. The rest is just a consequence of that decision.

  • docs: Move OEP-2 to archived.
  • docs: Change how we track release data.
  • docs: Update documents as a consequence of OEP-55:ADR-4
  • docs: Other minor docs cleanup.

@feanil feanil changed the title feanil/nopenedx yaml Use catalog-info.yaml for release metadata. Get rid of openedx.yaml Sep 28, 2023
@feanil feanil requested a review from e0d September 28, 2023 18:17
Details about why are in ADR-4 of OEP-55 which is in a follow-on commit.
Track release information in the `catalog-info.yaml` file instead of in
the `openedx.yaml` file.  This will supersede the decision made in OEP-2.
Copy link
Contributor

@nedbat nedbat left a comment

Choose a reason for hiding this comment

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

One missing word, then merge it!

…atalog-info-files.rst

Co-authored-by: Ned Batchelder <ned@edx.org>
Copy link

@jalondonot jalondonot left a comment

Choose a reason for hiding this comment

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

Seems good to me!

@feanil feanil merged commit 006635c into master Oct 3, 2023
4 checks passed
@feanil feanil deleted the feanil/nopenedx-yaml branch October 3, 2023 13:35
@nedbat
Copy link
Contributor

nedbat commented Oct 10, 2023

I'm realizing now (while watching the Quince cut) that we no longer have a way to say "maybe." What will our approach be? With openedx.yaml, the cookiecutter started the file off with maybe:true as a way to alert the release manager that no decision had been recorded.

Do we want to use the complete absence of the key to mean that?

@feanil
Copy link
Contributor Author

feanil commented Oct 11, 2023

@nedbat good point, I've created #529 to address that.

@kdmccormick
Copy link
Member

@feanil could you toss an issue on the BTR board so that we remember to apply this change before Redwood?

@feanil
Copy link
Contributor Author

feanil commented Feb 13, 2024

@kdmccormick I think nothing needs to change on the BTR side, once openedx/repo-tools#467 lands, it should to work automatically.

@kdmccormick
Copy link
Member

Ah, I wasn't aware of that PR. Cool, thanks.

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.

4 participants