Skip FOLIO Project Navigation

Introduction

If a repository is no longer maintained, and a decision has been made to archive the repository, then follow this procedure.

(Note: If the repository is to be renamed rather than archived, then there are various ramifications. Tread very carefully and follow the guide Rename a module instead.)

Raise a Jira ticket

Create a Jira ticket so that people are aware of what happened to the repository.

Certain operations will require Admin access to the repository. Please complete all tasks you have sufficient permissions for, then ask at Slack #devops channel.

If more complex then raise a FOLIO DevOps Jira ticket. Explain in the ticket what needs to happen, e.g. provide text for the README notice.

Ensure not in a Platform

Ensure that this module is not in a Stripes Platform, i.e. search in the platform-complete install.json generated file.

Its functionality should have already moved to other modules. If still present, then verify that no other module depends upon it (e.g. search the Registry of ModuleDescriptors).

If needed then declare such a task in the Jira ticket, as it may require DevOps assistance (especially if the old module is also still configured in folio-ansible).

Otherwise raise a pull-request for platform-complete snapshot branch. The module has probably been sitting in the “install-extras.json” file.

Deal with outstanding PRs

Address outstanding pull requests, e.g. Close with a comment.

This is also a chance to delete any old merged branches, where developers forgot to Maintain tidy repositories.

Add notice section to README

Add a new section to the README with heading DEPRECATED to explain what happened. Add this section after the copyright/license notice, and before the Introduction section.

See an example at mod-bursar-export.

Also adjust the copyright year to match the last actual code commit.

Adjust the About description

In the top-right panel of its GitHub front page is the “About” Description of the repository. This concise description is shown in various listings of repositories.

Adjust it to prepend a concise deprecation notice to the existing description.

See other examples by using the “Repositories” filter at the FOLIO Organization Overview. Replace the default text “Find a repository” with “deprecated”.

Archive as read-only

At GitHub use the repository Settings: “Archive this repository – Mark this repository as archived and read-only”.

Review the GitHub documentation before proceeding.

This will disable push access and pull requests. It leaves the teams configured, and can be temporarily reversed if needed. This also enables scripts to avoid “archived” repositories.

Finalise

Add a comment to FOLIO-1838. This is a list of all archived modules.