diff --git a/.github/workflows/README.md b/.github/workflows/README.md index ac73de9..12363e1 100644 --- a/.github/workflows/README.md +++ b/.github/workflows/README.md @@ -1,2 +1,15 @@ -# About latex-builder workflow +# About 42AI actions + +## make-it.yml + +> On any push, regardless of the branch, this action will attempt to build the PDFs. + +## release-it.yml + +> Branch : MASTER + +For any push on MASTER branch, this action will build the PDFs and publish a new release for the project. + +> NB: For the new release to appear, uploaded code must contain a non-existing VERSION. +> Adapt the content of the file `/version` accordingly. diff --git a/.github/workflows/make-it.yml b/.github/workflows/make-it.yml new file mode 100644 index 0000000..e6e6240 --- /dev/null +++ b/.github/workflows/make-it.yml @@ -0,0 +1,32 @@ +name: make-it + +on: [push] + +jobs: + make-it: + permissions: + contents: write + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: actions/checkout@v4 + - name: Install LaTex utilities + run: sudo apt update && sudo apt-get install -y texlive-full + - name: Get version from file + id: get_version + run: echo "VERSION=version/$(cat version)" >> $GITHUB_ENV + - name: Name release from version + id: get_release + run: echo "RELEASE=release_$(cat version)" >> $GITHUB_ENV + - name: Build PDFs + run: make + - name: Upload PDFs archives + uses: actions/upload-artifact@v4 + with: + name: modules.pdf + path: | + build/module00.pdf + build/module01.pdf + build/module02.pdf + build/module03.pdf + build/module04.pdf \ No newline at end of file diff --git a/.github/workflows/latex-builder.yml b/.github/workflows/release-it.yml similarity index 89% rename from .github/workflows/latex-builder.yml rename to .github/workflows/release-it.yml index ba701b5..d8de0e4 100644 --- a/.github/workflows/latex-builder.yml +++ b/.github/workflows/release-it.yml @@ -1,17 +1,18 @@ -name: Latex Builder +name: release-it on: [push] jobs: - make-it: + release-it: permissions: contents: write runs-on: ubuntu-latest + if: contains(github.ref, 'master') steps: - name: Checkout repository uses: actions/checkout@v4 - name: Install LaTex utilities - run: sudo apt-get install -y texlive-full + run: sudo apt update && sudo apt-get install -y texlive-full - name: Get version from file id: get_version run: echo "VERSION=version/$(cat version)" >> $GITHUB_ENV diff --git a/CHANGELOG.md b/CHANGELOG.md index 1528b69..6ff3897 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,19 +1,5 @@ ## Fixs -> Module00: PR #249; PR #253 -> Module01: PR #248 -> Module02: PR #254 -> Module03: PR #250 -> Module04: N/A +> Actions worfklows split in two files depending on whether a push is made on the master branch or not. +> Updated README -## CI/CD - -> - Fixed and updated broken `LaTex Builder` Github actions workflow - -## Other modifications - -> - Corrected spelling or grammar mistakes -> - Updated logo in module/subjets/assets -> - Updated logo in resources/42ai_logo -> - Updated README -> - Added a link on each project PDF introduction to reach our Discord server via the 42 associations portal on Discord (reserved to 42students). Edited the text to reach 42 and 42AI's Slack servers. diff --git a/README.md b/README.md index 4c099d9..a9582ce 100644 --- a/README.md +++ b/README.md @@ -24,9 +24,13 @@ - [Beta-testers](#beta-testers) - [Thanks to Ilyes and Kévin for the PR](#thanks-to-ilyes-and-kévin-for-the-pr) -This project is a Python programming and Machine Learning bootcamp created by [42 AI](http://www.42ai.fr). +>This project is a Python programming and Machine Learning bootcamp created by [42 AI](http://www.42ai.fr). +> +>No prior Python programming or Machine Learning experience is required! -No prior Python programming or Machine Learning experience is required! Your mission, should you choose to accept it, is to come and learn some of the essential knowledge for Machine Learning, Data Science and statistics, in a single week. You will start with the basics of the Python language and then get acquainted with some libraries that are invaluable to any programmer interested in the field of AI or data science. +Your mission, should you choose to accept it, is to learn some of the essential knowledge for Machine Learning, Data Science and statistics, in a single week. + +You will start with the basics of **Python** and then get acquainted with some libraries that are invaluable to any programmer interested in the field of AI or data science. 42 Artificial Intelligence is a student organization of the Paris campus of the school 42. Our purpose is to foster discussion, learning, and interest in the field of artificial intelligence, by organizing various activities such as lectures and workshops. @@ -68,6 +72,7 @@ The pdf files of each module can be downloaded from our realease page: * Tristan Duquesne (tduquesn@student.42.fr) * Pierre Peigné (ppeigne@student.42.fr) * Quentin Feuillade Montixi (qfeuilla@student.42.fr) +* Mathieu Perez (mathieu.perez@42ai.fr) ### Beta-testers diff --git a/version b/version index 6d260c3..040943e 100644 --- a/version +++ b/version @@ -1 +1 @@ -v3.2.0 +v3.2.1