From ac7ce5b5e47c2f5f9ddfb37089b3e5c2f867d8d4 Mon Sep 17 00:00:00 2001 From: Vijay A Date: Mon, 12 Jul 2021 08:51:32 +0530 Subject: Documentation updates taken from #1629 [skip ci] Co-authored-by: mhatvan --- .github/workflows/ferdi-builds.yml | 14 +++++++------- CONTRIBUTING.md | 6 +++--- Dockerfile | 2 +- 3 files changed, 11 insertions(+), 11 deletions(-) diff --git a/.github/workflows/ferdi-builds.yml b/.github/workflows/ferdi-builds.yml index c0ac073d0..277721c8c 100644 --- a/.github/workflows/ferdi-builds.yml +++ b/.github/workflows/ferdi-builds.yml @@ -2,13 +2,13 @@ # For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions # Note: This workflow requires some secrets setup, and set on this repo with the names: - # 'FERDI_PUBLISH_TOKEN' (A GitHub Personal Access Token with appropriate permissions - for publishing the built artifacts) - # 'APPLEID' (The username of your Apple developer account - for notarizing the mac artifacts) - # 'APPLEID_PASSWORD' (An app-specific password - for notarizing the mac artifacts) - # 'CSC_LINK' (The HTTPS link or local path to certificate - for code signing of mac artifacts) - # 'CSC_KEY_PASSWORD' (The password to decrypt the certificate given in CSC_LINK - for code signing of mac artifacts) - # 'WIN_CSC_LINK' (The HTTPS link or local path to certificate - for code signing of windows artifacts) - # 'WIN_CSC_KEY_PASSWORD' (The password to decrypt the certificate given in CSC_LINK - for code signing of windows artifacts) +# 'FERDI_PUBLISH_TOKEN' (A GitHub Personal Access Token with appropriate permissions - for publishing the built artifacts) +# 'APPLEID' (The username of your Apple developer account - for notarizing the mac artifacts) +# 'APPLEID_PASSWORD' (An app-specific password - for notarizing the mac artifacts) +# 'CSC_LINK' (The HTTPS link or local path to certificate - for code signing of mac artifacts) +# 'CSC_KEY_PASSWORD' (The password to decrypt the certificate given in CSC_LINK - for code signing of mac artifacts) +# 'WIN_CSC_LINK' (The HTTPS link or local path to certificate - for code signing of windows artifacts) +# 'WIN_CSC_KEY_PASSWORD' (The password to decrypt the certificate given in CSC_LINK - for code signing of windows artifacts) name: Ferdi Builds diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bf078dfaa..0b643ea10 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -52,9 +52,9 @@ As a basic rule, before filing issues, feature requests or anything else. Take a #### Node.js, npm, node-gyp -Please make sure you are running the exact node version used by the developers/contributors as specified in the [nvmrc file](./.nvmrc). +Please make sure you are conforming to the `engines` requirements used by the developers/contributors as specified in the [package.json file](./package.json#engines). -Currently, these are the combinations of system dependencies that work on an intel-based machines for MacOS/Linux/Windows (building on an ARM-based machine is still a work-in-progress due to node-sass native dependencies) +Currently, these are the combinations of system dependencies that work for MacOS/Linux/Windows: ```bash node -v @@ -74,7 +74,7 @@ _Note:_ This list can likely get outdated. If so, please refer to the specific v #### Debian/Ubuntu ```bash -apt-get update -y && apt install -y rpm ruby gem && gem install fpm --no-ri --no-rdoc --no-document +apt-get update -y && apt-get install --no-install-recommends -y rpm ruby gem && gem install fpm --no-ri --no-rdoc --no-document ``` #### Fedora diff --git a/Dockerfile b/Dockerfile index 005d25e4d..bb0381d31 100644 --- a/Dockerfile +++ b/Dockerfile @@ -13,7 +13,7 @@ ARG USE_SYSTEM_FPM=true ARG PREVAL_BUILD_INFO_PLACEHOLDERS=true RUN apt-get update -y \ - && apt-get install -y rpm ruby gem \ + && apt-get install --no-install-recommends -y rpm ruby gem \ && gem install fpm --no-ri --no-rdoc --no-document WORKDIR /usr/src/ferdi -- cgit v1.2.3-54-g00ecf