From 6ffc89fd762f1616925ae7293fa206319caeaaae Mon Sep 17 00:00:00 2001 From: cjfullerton Date: Wed, 2 Nov 2022 16:05:51 +0000 Subject: [PATCH 1/2] docs: Update sync instructions in README --- README.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 62043c5..b773b8f 100644 --- a/README.md +++ b/README.md @@ -42,13 +42,12 @@ In the target repository: - Add this repo as a remote: `git remote add python-release-workflow https://github.com/hpcflow/python-release-workflow.git` - Effectively set the remote as fetch-only to avoid accidentally pushing to it: `git remote set-url --push python-release-workflow no-pushing` -- Fetch all: `git fetch --all` -- Checkout this repo as a new branch in your repo: `git checkout -b python-release-workflow/main python-release-workflow/main` -- Checkout the branch you want to synchronise: `git checkout aplowman/develop` -- Checkout only the `.github` directory from this repository: `git checkout python-release-workflow/main -- .github/` +- Fetch branches and commits from the `python-release-workflow` repository: `git fetch --python-release-workflow`. Commits to `BRANCHBAME` in `python-release-workflow` will be stored locally in the branch `python-release-workflow/BRANCHNAME` +- Checkout the branch you want to synchronise workflow updates to: `git checkout aplowman/develop` +- Checkout only the `.github` directory from the `python-release-workflow` branch of interest: `git checkout python-release-workflow/BRANCHNAME -- .github/` - Stage, commit, and push the changes as normal: `git add .github/; git commit -m "build: update GH Actions workflows"; git push` -Note: once the remote is set up and you wish to synchronise again, we can fetch changes like this: `git fetch python-release-workflow main:python-release-workflow/main` (which takes the syntax: `git fetch :`) +Note: once the remote is set up and you wish to synchronise again, we can fetch changes from `python-release-workflow`: `git fetch --python-release-workflow`, and then repeating the checkout, stage, commit and push steps. ## Generating the workflow files from the Jinja2 templates From 824848ad6aa333af39ef72d8ad71cfab8d06aa1f Mon Sep 17 00:00:00 2001 From: cjfullerton Date: Wed, 2 Nov 2022 16:09:23 +0000 Subject: [PATCH 2/2] docs: Fix typos in README --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b773b8f..9748c43 100644 --- a/README.md +++ b/README.md @@ -42,12 +42,12 @@ In the target repository: - Add this repo as a remote: `git remote add python-release-workflow https://github.com/hpcflow/python-release-workflow.git` - Effectively set the remote as fetch-only to avoid accidentally pushing to it: `git remote set-url --push python-release-workflow no-pushing` -- Fetch branches and commits from the `python-release-workflow` repository: `git fetch --python-release-workflow`. Commits to `BRANCHBAME` in `python-release-workflow` will be stored locally in the branch `python-release-workflow/BRANCHNAME` +- Fetch branches and commits from the `python-release-workflow` repository: `git fetch --python-release-workflow`. Commits to `BRANCHNAME` in `python-release-workflow` will be stored locally in the branch `python-release-workflow/BRANCHNAME` - Checkout the branch you want to synchronise workflow updates to: `git checkout aplowman/develop` - Checkout only the `.github` directory from the `python-release-workflow` branch of interest: `git checkout python-release-workflow/BRANCHNAME -- .github/` - Stage, commit, and push the changes as normal: `git add .github/; git commit -m "build: update GH Actions workflows"; git push` -Note: once the remote is set up and you wish to synchronise again, we can fetch changes from `python-release-workflow`: `git fetch --python-release-workflow`, and then repeating the checkout, stage, commit and push steps. +Note: once the remote is set up and you wish to synchronise again, fetch changes from `python-release-workflow`: `git fetch --python-release-workflow`, and then repeat the checkout, stage, commit and push steps. ## Generating the workflow files from the Jinja2 templates