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

Repository archiving support #881

Open
mhitza opened this issue Mar 13, 2024 · 2 comments
Open

Repository archiving support #881

mhitza opened this issue Mar 13, 2024 · 2 comments

Comments

@mhitza
Copy link

mhitza commented Mar 13, 2024

Prerequisites:

  • Is the functionality available in the GitHub UI? If so, please provide a link to information about the feature.

https://docs.github.com/en/repositories/archiving-a-github-repository/archiving-repositories

https://docs.github.com/en/rest/repos/repos?apiVersion=2022-11-28#update-a-repository

Octokit documentation forwards to the same area of GitHub docs

  • If the functionality is not yet available in the API, it would be helpful if you
    contacted support (https://support.github.com/) or posted in the Community Forum (https://github.community/). Please
    include a link to the forum post if you create one or a copy of the response from support.

New Feature

Ability to archive a repository via an archive flag. It's understood, and implied, that once a repository is archived it would need to be manually unarchived as no additional changes can be made to the settings.yml until its unarchived. Useful in contexts where the settings.yml file is the canonical representation of repository state and managed/generated by external tooling.

@travi
Copy link
Member

travi commented Mar 13, 2024

all properties available for the api endpoint that you linked to should work in the repository section of the settings file. have you tried to use the archived boolean property?

@mhitza
Copy link
Author

mhitza commented Apr 7, 2024

@travi sorry for the delay, only got to test it now.

archived: true indeed works. Could be worth including missing properties in the configuration reference, as I was looking at that file as an authoritative source and not obvious that not all properties are present in the example file. The note at the top reads more like "for detailed information on each option consult the API reference".

Thanks.

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

No branches or pull requests

2 participants