Archiving DSACMS repositories
- Dominant language
- Shell
- Stars
- 1
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
## MENTOR
- @natalialuzuriaga, @sachin-panayil
- Software Engineer, CMS OSPO, Archiving Repositories
- #dsac-ospo on Slack
## BRIEF DESCRIPTION
The OSPO has identified repositories within the DSACMS GitHub organization to archive. To prepare repositories for archival, we would like to run repo-sunsetter and codejson-crosswalk to do this work.
We are using this slack canvas to track progress on this work. Please note all repository updates here: https://cmsgov.enterprise.slack.com/docs/TGYJGRB1T/F0BB99LNGVC
## SCOPING
- Downtime work to pick up whenever blocked
## SKILLS NEEDED
CI/CD, Documentation, Metadata
## REQUIRED DELIVERABLES
1. Natalia reviews results from archival-identifier and identifies repositories to archive. Finalized candidates are in [Slack Canvas tracker here](https://cmsgov.enterprise.slack.com/docs/TGYJGRB1T/F0BB99LNGVC)
2. During a rotation onboarding block, Natalia will give a quick presentation explaining the OSPO’s archival practices
- https://www.youtube.com/watch?v=T9DXykNLl3I for more information
3. Assignee uses [repo-sunsetter](https://github.com/DSACMS/repo-sunsetter) to prepare the repository candidates for archival. Workflow is as follows:
- Create a PR adding repo-sunsetter with correct parameters used. [Example here](https://github.com/DSACMS/open/actions/workflows/archive.yml). Set Natalia as reviewer and merge
- Assignee runs repo-sunsetter
- Assignee reviews and completes repo-sunsetter tasks:
- Adding archival notice to README. Assignee can merge themselves
- Update code.json. Assignee completes code.json to the best of their ability. Adds Natalia as a PR reviewer, merges PR.
- Assignee goes through tasks in checklist posted in issue
4. Assignee uses [codejson-crosswalk ](https://github.com/DSACMS/codejson-crosswalk)to create a codemeta.json file to add as PR to repository
- Adds Natalia and Sachin as a PR reviewer, merges PR.
5. Assignee notifies Natalia for final repository review.
6. Repository is ready for archival. Natalia will press the archive button
## DESIRED DELIVERY WINDOW
- Any
## NOTES/INSPO
Easy and straightforward downtime work to pick up whenever blocked. If you are interesting in understanding the CMS OSPO repository lifecycle and how we go about our software end of life practices, this is a good ticket to learn more!
Example of a repository we archived in the past: https://github.com/DSACMS/open/
Example of repo-sunsetter workflow: https://github.com/DSACMS/open/actions/workflows/archive.yml
Slack tracker here: https://cmsgov.enterprise.slack.com/docs/TGYJGRB1T/F0BB99LNGVC
# ACKNOWLEDGEMENTS
- [X] - Yes, I agree to spend file a project proposal ticket
- [x] - Yes, I agree this project falls within a 2 week or less (ideally less) scope of time
- [x] - Yes, I agree to spend an hour per week of office hours and 1x1 mentoring
- [x] - Yes, I agree to spend an hour at the end of the sprint for filling out a Retro Template
Contributor guide
Research direction
Start with the Slack Canvas tracker to identify finalized repository candidates, then review the example archive.yml workflow and the repo-sunsetter and codejson-crosswalk documentation. For each candidate, complete the README archival notice, code.json updates, codemeta.json addition, and checklist, obtain the specified reviews, and notify Natalia for final archival.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, shell
- Domain
- devops, documentation, release
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100