diff --git a/docs/make.jl b/docs/make.jl index dbfcd52..0eb66a1 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -10,7 +10,8 @@ function doit() pages=["Introduction"=>"index.md", "API"=>"api.md", "Theory"=>"theory.md", - "Software Quality Assurance"=>"sqa.md"]) + "Software Quality Assurance"=>"sqa.md", + "Developer Notes"=>"dev.md"]) if IN_CI deploydocs(repo="github.com/OpenMDAO/AcousticMetrics.jl.git", devbranch="main") diff --git a/docs/src/dev.md b/docs/src/dev.md new file mode 100644 index 0000000..d8e4771 --- /dev/null +++ b/docs/src/dev.md @@ -0,0 +1,17 @@ +# Developer Notes + +## CompatHelper.jl, Running Tests, and Signing Commits +CompatHelper.jl will automatically look for new versions of AcousticMetrics.jl's dependencies and, if it finds any breaking versions, open PRs with AcousticMetrics.jl's `Project.toml` to incorporate the new versions. +But! +The PR won't automatically run the GitHub Action tests: https://github.com/peter-evans/create-pull-request/blob/main/docs/concepts-guidelines.md#triggering-further-workflow-runs +A workaround is to manually close and immediately re-open the PR, which will run the tests and isn't too much work. + +The next problem: commits created by CompatHelper.jl/the github-actions bot aren't signed, and AcousticMetrics.jl is set up to require signed commits when merging into the `main` branch. +So, what to do? +Check out the CompatHelper.jl PR locally, manually sign the commits, then submit a new PR with the freshly-signed commits using this procedure: + +* First, check the CompatHelper.jl PR locally: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally?tool=cli +* Next, manually sign the CompatHelper.jl commit using git rebase: https://superuser.com/questions/397149/can-you-gpg-sign-old-commits# +* Then push the branch with the newly signed commits to my fork, and merge +* Close this CompatHelper.jl PR :-/ +