Skip to content

Commit a70924d

Browse files
committed
Separate build and deploy for creating a PDF such that a new branch requirement is enforced for releases of CV, per #2. Adds minimal documentation in the README for this.
1 parent 8935943 commit a70924d

File tree

2 files changed

+11
-2
lines changed

2 files changed

+11
-2
lines changed

.github/workflows/create-pdf.yml

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@ name: Create PDF
22

33
on:
44
push:
5-
branches: [ main ]
5+
branches: [ main, drafting ]
66
pull_request:
7-
branches: [ main ]
7+
branches: [ main, drafting ]
88
workflow_dispatch:
99

1010
jobs:
@@ -28,6 +28,11 @@ jobs:
2828
name: cv
2929
path: cv/cv.pdf
3030
compression-level: 0 # don't compress PDF
31+
deploy:
32+
runs-on: ubuntu-latest
33+
needs: build
34+
if: github.ref == 'refs/heads/main'
35+
steps:
3136
- name: Tag
3237
id: generate_release_tag
3338
uses: amitsingh-007/next-release-tag@v5.1.0

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@ TODO.
1515

1616
TODO.
1717

18+
## Development
19+
20+
Changes take place in the `drafting` branch. The `main` branch serves as the latest stable and released version of the CV, including its contents and the methods for generating it. When a CV draft is ready for release, make a pull request to merge the draft into `main`. If all checks pass, complete the merge to build and release a new version of the CV. Versions are formatted with `v{yyyy}.{mm}.{dd}.{i}`, e.g., [v2024.5.4.1](https://github.com/aridyckovsky/cv/releases/tag/v2024.5.4.1). Multiple versions within a day are tracked by an increasing sequence of natural numbers `i`.
21+
1822
## Acknowledgements
1923

2024
This automation is made possible with the help of great open source contributiosn like:

0 commit comments

Comments
 (0)