Advent of Code {year}

Housekeeping

Before creating a new repository from this template, perform the following steps.

Personal Access Token Setup

Open Personal access tokens (classic) settings and verify if there is any PAT_TOKEN or if it is nearly to expire.

Creation of a new token

If there is no PAT_TOKEN created:

1. Click on Generate New Token.
2. Select repo checkbox.
3. Copy the token.

Refresh of an existing token

If there is an existing PAT_TOKEN:

1. Click on it.
2. If the expiration date is due soon, click on regenerate the token.
3. Update the PAT_TOKEN at this template repository.

Update dependencies

Open dependency graph settings and manually run the following jobs:

• pom.xml
• .github/workflows/build-report.yml

Review and merge any pending pull requests.

New repository creation

Follow this steps after housekeeping is finished.

Creation

1. Open the main page of the template repository.
2. Click on Use this template.
3. Select Create a new repository:
   1. Give a name to the new repository. Example: advent-of-code-2022.

Personal Access Token Setup

Add the previously mentioned PAT_TOKEN to this new repository.

Codacy Project Token Setup

1. Go to Codacy and add the repository.
2. Open Settings / Coverage and copy the CODACY_PROJECT_TOKEN value.
3. Open the created repository.
4. Open Settings / Secrets and variables / Actions and click on New repository secret:
   1. Name: CODACY_PROJECT_TOKEN
   2. Secret: The previously copied token.

Update repository information

1. Go to Settings / Actions / General.
2. Under Workflow permissions:
   1. Enable Read and write permissions.
   2. Enable Allow GitHub Actions to create and approve pull requests.
3. Go to Actions and open the Update year workflow:
   1. Click on Run workflow.
   2. Type the year in yyyy format and click on Run workflow.

After the workflow has ended a Pull Request will be created:

1. Open the pull request.
2. Verify everything is right and then merge it.

After the PR is merged the repository will have its description and topics updated. Also, all README.md and pom.xml will be updated with current year value. The PR can be declined and workflow can be executed again if there was any problem that needed a fix.

Data Repository Setup

1. Create a private data repository using advent-of-code-yyyy-data template repository and set it up.
2. Add the data repository as a submodule using the command:

git clone https://github.com/Flashky/advent-of-code-{year}.git &&
cd advent-of-code-{year} &&
git submodule add -b master https://github.com/Flashky/advent-of-code-{year}-data.git src/test/resources/inputs && 
git push

Codacy Badges Setup

1. Go to Codacy and open the repository.
2. Open Settings / General and copy both the code quality and coverage badges.
3. Add them to this README.md.

Almost done...

1. Remove these instructions from README.md.
2. Push the changes and...

Enjoy your new Advent of Code edition!

---

• Day 1
• Day 2
• Day 3
• Day 4
• Day 5
• Day 6
• Day 7
• Day 8
• Day 9
• Day 10
• Day 11
• Day 12
• Day 13
• Day 14
• Day 15
• Day 16
• Day 17
• Day 18
• Day 19
• Day 20
• Day 21
• Day 22
• Day 23
• Day 24
• Day 25

Cloning this repository

Without data repository:

git clone https://github.com/Flashky/advent-of-code-{year}.git

Including data repository:

git clone https://github.com/Flashky/advent-of-code-{year}.git --recurse-submodules

About

• Advent of Code