diff --git a/.github/workflows/gitlab_ci.yml b/.github/workflows/gitlab_ci.yml index a033b9909f2a55a4a928f5a3088e625a5ccb2ebc..0b99b6377f866028d2ed6748aa4d9455b593eab6 100644 --- a/.github/workflows/gitlab_ci.yml +++ b/.github/workflows/gitlab_ci.yml @@ -117,7 +117,7 @@ jobs: MIRROR_BRANCH: ${{ env.MIRROR_BRANCH }} get_artifacts_from_other_workflow: - runs-on: ubuntu-latest# + runs-on: ubuntu-latest needs: - mirror_to_gitlab steps: @@ -196,3 +196,10 @@ jobs: merge-multiple: true run-id: ${{ steps.get_id.outputs.result }} github-token: ${{ secrets.ACTION_READ_TOKEN }} + path: ./github_ci_artifacts + - name: Uploading artifacts + uses: actions/upload-artifact@v4 + with: + name: Github_CI_artifacts + path: | + ./github_ci_artifacts/* diff --git a/.github/workflows/postprocess.yml b/.github/workflows/postprocess.yml index ed27d041c9ba47b854f5d735bac1359575b06e35..f606c6d93a9f4fa38902bfff2e55af18664ccec5 100644 --- a/.github/workflows/postprocess.yml +++ b/.github/workflows/postprocess.yml @@ -1,6 +1,6 @@ --- -name: CI pipeline for pySDC +name: Create Website for pySDC on: workflow_run: @@ -8,7 +8,7 @@ on: types: ["completed"] jobs: - post-processing: + build_website: runs-on: ubuntu-latest if: >- ${{ github.repository_owner == 'Parallel-in-Time' diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a3e3e92088bc79a252e6e270f6b39f37ae251c9b..d8feadc215f7ede556ff2b43c6e6052fae0e4ba0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,15 +1,28 @@ # How to contribute to pySDC Developments on the `pySDC` code use the classical approach of forks and pull requests. -You can look at [extended GitHub documentation](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models) for more details (skip this if you are already used to it). Furthermore, branches on `pySDC` follow a pre-defined structure. To contribute to any of them, please look at the [pull request recommendations](./docs/contrib/01_pull_requests.md). +You can look at [extended GitHub documentation](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models) +for more details (skip this if you are already used to it). +Furthermore, branches on `pySDC` follow a pre-defined structure. +To contribute to any of them, please look at the [pull request recommendations](./docs/contrib/01_pull_requests.md). -Additionally, a _few_ rules are set to enforce code readability, consistency and reliability. Some of them are automatically tested with each commit, and summarized in the page on [continuous integration (CI)](./docs/contrib/02_continuous_integration.md). -Others are specific conventions chosen for the pySDC library, that may follow Python standards (or not ...), detailed in the [naming conventions](./docs/contrib/03_naming_conventions.md) page. +Additionally, a _few_ rules are set to enforce code readability, +consistency and reliability. +Some of them are automatically tested with each commit, +and summarized in the page on [continuous integration (CI)](./docs/contrib/02_continuous_integration.md). +Others are specific conventions chosen for the pySDC library, +that may follow Python standards (or not ...), detailed in the +[naming conventions](./docs/contrib/03_naming_conventions.md) page. -Finally, while `pySDC` provides many base functionalities that implement classical flavors of SDC, it also allows problem-specific applications through Object-Oriented Programming (OOP) and the implementation of custom inherited classes. -This follows a specific OOP framework, you can look at the page on [custom implementations](./docs/contrib/04_custom_implementations.md) for more details. Additional guideline are also given on how to [document the code](./docs/contrib/05_documenting_code.md) in `pySDC`. +Finally, while `pySDC` provides many base functionalities that implement +classical flavors of SDC, it also allows problem-specific applications through +Object-Oriented Programming (OOP) and the implementation of custom inherited classes. +This follows a specific OOP framework, you can look at the page on +[custom implementations](./docs/contrib/04_custom_implementations.md) +for more details. Additional guideline are also given on how to +[document the code](./docs/contrib/05_documenting_code.md) in `pySDC`. -> 📣 Some core components (collocation matrix, $Q-\Delta$ coefficients, Lagrange barycentric interpolation) +> 📣 Some core components (collocation matrix, $Q-\Delta$ coefficients, Lagrange barycentric interpolation) > are implemented and developed in the [`qmat` companion package](https://github.com/Parallel-in-Time/qmat). > Checkout its own [contributing guide](https://qmat.readthedocs.io/en/latest/contributing.html) > to add any new coefficient / feature on this part.