Skip to content

Commit 228e1b8

Browse files
format: update links and remove irrelevant content
1 parent 65e881a commit 228e1b8

File tree

1 file changed

+9
-18
lines changed
  • docs/continuous-integration/github-workflow

1 file changed

+9
-18
lines changed

docs/continuous-integration/github-workflow/index.md

Lines changed: 9 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,12 @@
11
# GitHub Workflows
22

3-
<!-- ![GitHub Actions banner](https://raw.githubusercontent.com/practicalli/graphic-design/live/banners/github-actions-banner.png) -->
4-
5-
Automate tasks, such as running unit tests or lint code, whenever code is committed to a GitHub repository.
6-
7-
GitHub Actions can run one or more tasks after specific events, such as commits, raising issues or pull requests.
3+
GitHub workflows can run one or more tasks when triggered by specific events, e.g. pushing commits, raising issues or pull requests.
84

95
An event triggers a configured workflow which contains one or more jobs. A job contains a one or more steps which defines actions to run.
106

11-
[Practicalli GitHub Workflow Examples](https://practical.li/engineering-playbook/continuous-integration/github-workflow/){target=_blank .md-button}
12-
[Practicalli recommended GitHub Actions](https://practical.li/engineering-playbook/continuous-integration/github-actions/){target=_blank .md-button}
7+
[:fontawesome-solid-book-open: Practicalli GitHub Workflows](https://practical.li/engineering-playbook/continuous-integration/github/workflows/practicalli/){target=_blank .md-button}
138

14-
[Introduction to GitHub Actions](https://docs.github.com/en/free-pro-team@latest/actions/learn-github-actions/introduction-to-github-actions){target=_blank .md-button}
15-
[Understanding the workflow file](https://docs.github.com/en/free-pro-team@latest/actions/learn-github-actions/introduction-to-github-actions#understanding-the-workflow-file){target=_blank .md-button}
9+
[:globe_with_meridians: Understanding GitHub Actions](https://docs.github.com/en/actions/about-github-actions/understanding-github-actions){target=_blank .md-button}
1610

1711
## Anatomy of a workflow
1812

@@ -29,9 +23,12 @@ An event triggers a configured workflow which contains one or more jobs. A job c
2923

3024
`.github/workflows/workflow-name.yaml` is a file that contains the workflow definition.
3125

32-
[Setup Java](https://github.com/actions/setup-java){target=_blank} adds an OpenJDK distribution, i.e. Eclipse Temurin, at a specified version (Java 17 recommended).
26+
> NOTE: Practicalli recommends including additional configuration in `.github/config/` files where required, rather than the root directory of a project
27+
3328

34-
[Setup Clojure](https://github.com/DeLaGuardo/setup-clojure){target=_blank} provides Clojure via Clojure CLI, Leiningen or Boot. Clojure CLI is recommended.
29+
[Setup Java](https://github.com/actions/setup-java){target=_blank} adds an OpenJDK distribution, i.e. Eclipse Temurin, at a specified version.
30+
31+
[Setup Clojure](https://github.com/DeLaGuardo/setup-clojure){target=_blank} provides Clojure via Clojure CLI or Leiningen.
3532

3633
[Cache](https://github.com/actions/cache){target=_blank} is used to cache Clojure and Java libraries
3734

@@ -70,7 +67,7 @@ An event triggers a configured workflow which contains one or more jobs. A job c
7067
uses: actions/setup-java@v3
7168
with:
7269
distribution: 'temurin'
73-
java-version: '17'
70+
java-version: '21'
7471

7572
- name: Install clojure tools
7673
uses: DeLaGuardo/setup-clojure@9.5
@@ -91,9 +88,3 @@ An event triggers a configured workflow which contains one or more jobs. A job c
9188
- name: Package Clojure project
9289
run: clojure -X:project/uberjar
9390
```
94-
95-
## References
96-
97-
* [Practicalli Blog - publish blog workflow](https://github.com/practicalli/blog/blob/live/.github/workflows/publish-blog.yml) - build publish a Cryogen project with Clojure CLI and publish the generated website with GitHub pages (also [a Staging workflow that runs on pull requests](https://github.com/practicalli/blog/blob/live/.github/workflows/publish-blog-staging.yml))
98-
* [Practicalli Landing Page GitHub workflow](https://github.com/practicalli/practicalli.github.io/blob/live/.github/workflows/deploy.yml) - build a ClojureScript & Figwheel project with Clojure CLI and publish the generated site to GitHub pages
99-
* [Practicalli Clojure CLI config - lint with clj-kondo workflow](https://github.com/practicalli/clojure-deps-edn/blob/live/.github/workflows/lint-with-clj-kondo.yml) - lint the `deps.edn` file with clj-kondo

0 commit comments

Comments
 (0)