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

Update BTR release scripts to look at catalog-info.yaml for release info. #439

Closed
2 tasks done
Tracked by #882
feanil opened this issue Sep 19, 2023 · 3 comments
Closed
2 tasks done
Tracked by #882
Assignees

Comments

@feanil
Copy link
Contributor

feanil commented Sep 19, 2023

The tag_release.py script in repo-tools currently looks at the openedx.yaml file to determine if a repo should be tagged for an open-edx release. But we want to move this information into the catalog-info.yaml file.

Currently it looks for the openedx-release key in an openedx.yaml. eg.

openedx-release:
  ref: main

We want it to check to see if there is a catalog-info.yaml file and if it has an annotation for the openedx-release. eg.

metadata:
  annotations:
    openedx.org/release: "main"

Tasks

  • Update the tag_release.py script to read from both locations and prefer the info in catalog-info.yaml if it exists.
  • Get it reviewed by nedbat (You can still tag @feanil or other Aximprovements members for review first.)
@feanil feanil converted this from a draft issue Sep 19, 2023
@feanil feanil moved this from 🆕 New to 🔖 Ready in Aximprovements Team Oct 12, 2023
@salman2013 salman2013 self-assigned this Nov 2, 2023
@feanil feanil moved this from 🔖 Ready to 🏗 In progress in Aximprovements Team Nov 8, 2023
@salman2013
Copy link
Contributor

@feanil
For the openedx.yaml file there is an addition method which check for parent repo and add some more information. is there a similar case that exists for the catalog-info.yaml file?
if yes then i would also need to update this as the format for the catalog-info.yaml file is different and it is checking
openedx-release tag.

def trim_dependent_repos(repos):
    """Remove dependent repos (an obsolete feature of this program).

    Repos with 'parent-repo' in their 'openedx-release' data are removed from
    the `repos` dict.  A new dict of repos is returned.

    """
    trimmed = {}

    for r, data in repos.items():
        if 'parent-repo' in data['openedx-release']:
            msg = f"Repo {r} is dependent: you can remove openedx-release from its openedx.yaml file"
            click.secho(msg, fg='yellow')
        else:
            trimmed[r] = data

    return trimmed

@feanil
Copy link
Contributor Author

feanil commented Dec 6, 2023

You can ignore this function, it should probably get removed. See the first line of the docstring. This feature is obsolete and we don't need to port it as a part of your changes.

@salman2013 salman2013 moved this from 🏗 In progress to 👀 In review in Aximprovements Team Dec 14, 2023
@salman2013
Copy link
Contributor

PR link #467

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

No branches or pull requests

2 participants