Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Various documentation and CI updates #325

Merged
merged 21 commits into from
Mar 20, 2024
Merged

Conversation

MakisH
Copy link
Member

@MakisH MakisH commented Mar 19, 2024

  • Bump default OpenFOAM version from v2306 to v2312.
  • Update badges, add a link to the forum in the badges, to direct people there for questions, instead of the issues.
  • Build CI workflow: switch from the setup-precice-action (slow) to precice/precice:nightly.
  • Move shellcheck to pre-commit and rename workflow.

TODO list:

  • I updated the documentation in docs/
  • I added a changelog entry in changelog-entries/ (create directory if missing) -> N/A

@MakisH MakisH self-assigned this Mar 19, 2024
@MakisH MakisH requested a review from davidscn March 19, 2024 20:47
docs/get.md Outdated Show resolved Hide resolved
@MakisH MakisH requested a review from davidscn March 20, 2024 18:16
@MakisH
Copy link
Member Author

MakisH commented Mar 20, 2024

I also switched from using the preCICE Debian packages to the setup-precice-action in the build-custom: https://github.com/precice/openfoam-adapter/actions/runs/8364095082

@MakisH
Copy link
Member Author

MakisH commented Mar 20, 2024

Something seems to be completely broken in regarding the step outputs in GitHub Actions. Even though we don't seem to have changed anything related, the value of openfoam_exec we set in the InstallOpenFOAM step does not propagate to the adapter installation step.

Documentation: https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#setting-an-output-parameter

I suspect that there is either a bug with GitHub Actions, or something changed and is not documented.

Example job that fails: https://github.com/precice/openfoam-adapter/actions/runs/8365204318/job/22902472048

Note that I could install OpenFOAM v2206 on Ubuntu 22.04, but several other combinations seemed to lead to various sourceforge-related issues (404 for various subpackages).

@MakisH
Copy link
Member Author

MakisH commented Mar 20, 2024

The workflow is broken even on develop. This PR has nothing to do with it. I give up and merge.

@MakisH MakisH merged commit fa8a71d into precice:develop Mar 20, 2024
13 of 14 checks passed
@MakisH MakisH deleted the update-docs branch March 20, 2024 21:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants