From e65df45188191f0acd81e334bd941a319d5950e9 Mon Sep 17 00:00:00 2001 From: eliselavy <35602279+eliselavy@users.noreply.github.com> Date: Tue, 26 Sep 2023 14:32:15 +0200 Subject: [PATCH] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 03c317f..f61addb 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ The preflight action generates a report within the repository that contains info `author_guideline_template.ipynb` - This Jupyter notebook provides an example and a simple structure that authors can use to write articles for the Journal of Digital History. -`.github/workflows/preflight.yml` - This workflow file contains the preflight action that can be triggered automatically on commit or manually using the workflow_dispatch event to check that the article respects the Journal guidelines. +`.github/workflows/github-actions-preflight.yml` - This workflow file contains the preflight action that can be triggered automatically on commit or manually using the workflow_dispatch event to check that the article respects the Journal guidelines. The preflight action generates or updates a report markdown file in the repository that provides information about the adherence of the article to the submission guidelines, usually named `report.md` @@ -32,7 +32,7 @@ Use the example notebook as a template to write your article. You can modify the ## Preflight Action -To check if the article respects the Guidelines, we decided to create a `preflight` GitHub action that can be triggered automatically on commit - or manually using the `workflow_dispatch` event. The action is triggered by the `preflight.yml` file in the `.github/workflows` folder. +To check if the article respects the Guidelines, we decided to create a `preflight` GitHub action that can be triggered automatically on commit - or manually using the `workflow_dispatch` event. The action is triggered by the `github-actions-preflight.yml` file in the `.github/workflows` folder. By default, the preflight action is set to `workflow_dispatch`, which means you can manually trigger it by going to the "Actions" tab in the repository, selecting the "Preflight" workflow, and clicking the "Run workflow" button. The preflight action will generate a report in the repository that provides information about the adherence of your article to the submission guidelines. -- GitLab