From 00784a75213e24e0dad196f27fabec41ba07eace Mon Sep 17 00:00:00 2001 From: Anton Reinhard Date: Fri, 9 Aug 2024 15:47:19 +0200 Subject: [PATCH 1/6] Hide the mul function (#42) Rename the mul function to _mul since it is not exported. Goes together with https://github.com/QEDjl-project/QEDbase.jl/pull/110 --- .../dirac_tensors/multiplication.jl | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/src/algebraic_objects/dirac_tensors/multiplication.jl b/src/algebraic_objects/dirac_tensors/multiplication.jl index e7117ca..a529343 100644 --- a/src/algebraic_objects/dirac_tensors/multiplication.jl +++ b/src/algebraic_objects/dirac_tensors/multiplication.jl @@ -16,10 +16,10 @@ Tensor product of an adjoint with a standard bi-spinor resulting in a scalar. This also overloads the `*` operator for this types. """ -function mul(aBS::AdjointBiSpinor, BS::BiSpinor)::ComplexF64 +function _mul(aBS::AdjointBiSpinor, BS::BiSpinor)::ComplexF64 return aBS.el1 * BS.el1 + aBS.el2 * BS.el2 + aBS.el3 * BS.el3 + aBS.el4 * BS.el4 end -@inline *(aBS::AdjointBiSpinor, BS::BiSpinor) = mul(aBS::AdjointBiSpinor, BS::BiSpinor) +@inline *(aBS::AdjointBiSpinor, BS::BiSpinor) = _mul(aBS::AdjointBiSpinor, BS::BiSpinor) """ $(TYPEDSIGNATURES) @@ -30,10 +30,10 @@ Tensor product of a standard with an adjoint bi-spinor resulting in a Dirac matr This also overloads the `*` operator for this types. """ -function mul(BS::BiSpinor, aBS::AdjointBiSpinor)::DiracMatrix +function _mul(BS::BiSpinor, aBS::AdjointBiSpinor)::DiracMatrix return DiracMatrix(BS * transpose(aBS)) end -@inline *(BS::BiSpinor, aBS::AdjointBiSpinor) = mul(BS::BiSpinor, aBS::AdjointBiSpinor) +@inline *(BS::BiSpinor, aBS::AdjointBiSpinor) = _mul(BS::BiSpinor, aBS::AdjointBiSpinor) """ $(TYPEDSIGNATURES) @@ -44,7 +44,7 @@ Tensor product of an Dirac matrix with a standard bi-spinor resulting in another This also overloads the `*` operator for this types. """ -function mul(DM::DiracMatrix, BS::BiSpinor)::BiSpinor +function _mul(DM::DiracMatrix, BS::BiSpinor)::BiSpinor return DM * BS end @@ -57,10 +57,10 @@ Tensor product of an adjoint bi-spinor with a Dirac matrix resulting in another This also overloads the `*` operator for this types. """ -function mul(aBS::AdjointBiSpinor, DM::DiracMatrix)::AdjointBiSpinor +function _mul(aBS::AdjointBiSpinor, DM::DiracMatrix)::AdjointBiSpinor return transpose(aBS) * DM end -@inline *(aBS::AdjointBiSpinor, DM::DiracMatrix) = mul(aBS, DM) +@inline *(aBS::AdjointBiSpinor, DM::DiracMatrix) = _mul(aBS, DM) """ $(TYPEDSIGNATURES) @@ -71,7 +71,7 @@ Tensor product two Dirac matrices resulting in another Dirac matrix. This also overloads the `*` operator for this types. """ -function mul(DM1::DiracMatrix, DM2::DiracMatrix)::DiracMatrix +function _mul(DM1::DiracMatrix, DM2::DiracMatrix)::DiracMatrix return DM1 * DM2 end @@ -80,6 +80,6 @@ $(TYPEDSIGNATURES) Tensor product of Dirac matrix sandwiched between an adjoint and a standard bi-spinor resulting in a scalar. """ -function mul(aBS::AdjointBiSpinor, DM::DiracMatrix, BS::BiSpinor)::ComplexF64 +function _mul(aBS::AdjointBiSpinor, DM::DiracMatrix, BS::BiSpinor)::ComplexF64 return transpose(aBS) * DM * BS end From ec823d59fa32cea8b4cc0db6c83d229a7cd7bb9e Mon Sep 17 00:00:00 2001 From: Simeon Ehrig Date: Thu, 29 Aug 2024 13:50:40 +0200 Subject: [PATCH 2/6] add CI doc build job (#44) --- .github/workflows/BuildDeployDoc.yml | 33 ++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 .github/workflows/BuildDeployDoc.yml diff --git a/.github/workflows/BuildDeployDoc.yml b/.github/workflows/BuildDeployDoc.yml new file mode 100644 index 0000000..ca77b58 --- /dev/null +++ b/.github/workflows/BuildDeployDoc.yml @@ -0,0 +1,33 @@ +name: Build and Deploy Documentation + +on: + push: + branches: + - master + - dev + tags: "*" + pull_request: + +jobs: + build: + permissions: + contents: write + statuses: write + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: julia-actions/setup-julia@v1 + with: + version: "1.10" + - name: Install dependencies + run: | + julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()' + - name: set dependencies to dev branch version + if: (github.event_name == 'push' && github.ref_name != 'main') || (github.event_name == 'pull_request' && github.base_ref != 'main') + run: | + git clone -b dev https://github.com/QEDjl-project/QED.jl.git /tmp/integration_test_tools + julia --project=docs/ /tmp/integration_test_tools/.ci/set_dev_dependencies.jl + - name: Build and deploy + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # If authenticating with GitHub Actions token + run: julia --project=docs/ docs/make.jl From 63c10b7d7e2ba6f68c848202f0cca7c3d956bb5b Mon Sep 17 00:00:00 2001 From: Anton Reinhard Date: Thu, 29 Aug 2024 17:31:19 +0200 Subject: [PATCH 3/6] Remove Suppressor.jl (#46) See subtask in #24 , it is actually unused currently anyways. --- Project.toml | 2 -- 1 file changed, 2 deletions(-) diff --git a/Project.toml b/Project.toml index 3887651..0727a67 100644 --- a/Project.toml +++ b/Project.toml @@ -26,7 +26,6 @@ LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e" Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c" SafeTestsets = "1bc83da4-3b8d-516f-aca4-4fe02f6d838f" SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf" -Suppressor = "fd094767-a336-5f1f-9728-57cf17d0bbfb" Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40" [targets] @@ -35,6 +34,5 @@ test = [ "LinearAlgebra", "SafeTestsets", "Test", - "Suppressor", "SparseArrays", ] From 1f0e5f6bb2a33a098974357158fece1ba8eb8720 Mon Sep 17 00:00:00 2001 From: Anton Reinhard Date: Mon, 2 Sep 2024 20:01:46 +0200 Subject: [PATCH 4/6] Fix CI docs building (#47) Fixes CI branch names and `deploydocs` call. Apparently, the main branch did not ever deploy its documentation until now and the dev branch didn't update anymore... --- .github/workflows/BuildDeployDoc.yml | 2 +- docs/make.jl | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/BuildDeployDoc.yml b/.github/workflows/BuildDeployDoc.yml index ca77b58..882a6b7 100644 --- a/.github/workflows/BuildDeployDoc.yml +++ b/.github/workflows/BuildDeployDoc.yml @@ -3,7 +3,7 @@ name: Build and Deploy Documentation on: push: branches: - - master + - main - dev tags: "*" pull_request: diff --git a/docs/make.jl b/docs/make.jl index 979a5b0..91cc8b4 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -24,4 +24,4 @@ makedocs(; pages=["Home" => "index.md"], ) -deploydocs(; repo="github.com/QEDjl-project/QEDcore.jl", devbranch="main") +deploydocs(; repo="github.com/QEDjl-project/QEDcore.jl", push_preview=false) From e87cb63583000ce4717d6c0b6946249f1dba3c23 Mon Sep 17 00:00:00 2001 From: AntonReinhard Date: Mon, 2 Sep 2024 20:13:34 +0200 Subject: [PATCH 5/6] Update version to 0.1.1 --- Project.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Project.toml b/Project.toml index 0727a67..52be8c4 100644 --- a/Project.toml +++ b/Project.toml @@ -4,7 +4,7 @@ authors = [ "Uwe Hernandez Acosta ", "Anton Reinhard ", ] -version = "0.1.0" +version = "0.1.1" [deps] DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae" From 7d9b47f3feccf925307f244355d9c01bfa1e9daa Mon Sep 17 00:00:00 2001 From: AntonReinhard Date: Mon, 2 Sep 2024 20:17:46 +0200 Subject: [PATCH 6/6] Update changelog --- CHANGELOG.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index c5f53bf..378eef7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,21 @@ # Changelog +## Version 0.1.1 + +This release contains some minor fixes and CI work. No breaking changes have been introduced. + +[diff since 0.1.0](https://github.com/QEDjl-project/QEDcore.jl/compare/release-0.1.0...release-0.1.1) + +### Fixes + +- [#42](https://github.com/QEDjl-project/QEDcore.jl/pull/42): Make `mul` function private since `*` should be used instead +- [#47](https://github.com/QEDjl-project/QEDcore.jl/pull/47): Fix docs building to deploy to gh-pages correctly + +### Maintenance + +- [#44](https://github.com/QEDjl-project/QEDcore.jl/pull/44): Add docs building job to the CI +- [#46](https://github.com/QEDjl-project/QEDcore.jl/pull/46): Remove `Suppressor.jl` dependency which is not needed anymore + ## Version 0.1.0 **Initial Release**