Merge pull request #135 from TriPSs/improvements

refactor: Use compiled index.js instead of node_modules
2021-10-05 22:57:54 +02:00 · 2021-10-05 22:57:54 +02:00 · ae4858875f
parent 78f731c36b 9f9635115e
commit ae4858875f
8 changed files with 127 additions and 13 deletions
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@ -11,8 +11,9 @@ jobs:
      - name: Checkout code
        uses: actions/checkout@v2

-      - run: npm ci --prod
-      - run: git add node_modules -f
+      - run: npm ci
+      - run: npm run build
+      - run: git add ./lib -f

      - name: Generate changelog
        id: changelog
--- a/.github/workflows/test.yml
+++ b/.github/workflows/test.yml
@ -13,7 +13,11 @@ jobs:
        with:
          path: "./"

+      - run: npm ci
+      - run: npm run build
+      - run: rm -rf node_modules
      - run: npm ci --prod
+
      - run: touch ./fake-file.log
      - run: "git config --global user.email 'changelog@github.com'"
      - run: "git config --global user.name 'Awesome Github action'"
@ -47,7 +51,11 @@ jobs:
        with:
          path: "./"

+      - run: npm ci
+      - run: npm run build
+      - run: rm -rf node_modules
      - run: npm ci --prod
+
      - run: touch ./fake-file.log
      - run: "git config --global user.email 'changelog@github.com'"
      - run: "git config --global user.name 'Awesome Github action'"
@ -81,7 +89,11 @@ jobs:
        with:
          path: "./"

+      - run: npm ci
+      - run: npm run build
+      - run: rm -rf node_modules
      - run: npm ci --prod
+
      - run: touch ./fake-file.log
      - run: "git config --global user.email 'changelog@github.com'"
      - run: "git config --global user.name 'Awesome Github action'"
@ -115,7 +127,11 @@ jobs:
        with:
          path: "./"

+      - run: npm ci
+      - run: npm run build
+      - run: rm -rf node_modules
      - run: npm ci --prod
+
      - run: "git config --global user.email 'changelog@github.com'"
      - run: "git config --global user.name 'Awesome Github action'"

@ -143,7 +159,11 @@ jobs:
        with:
          path: "./"

+      - run: npm ci
+      - run: npm run build
+      - run: rm -rf node_modules
      - run: npm ci --prod
+
      - run: touch ./fake-file.log
      - run: "git config --global user.email 'changelog@github.com'"
      - run: "git config --global user.name 'Awesome Github action'"
@ -162,6 +182,40 @@ jobs:
          github-token: ${{ secrets.github_token }}
          skip-commit: 'true'

+  test-git-no-push:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          path: "./"
+
+      - run: npm ci
+      - run: npm run build
+      - run: rm -rf node_modules
+      - run: npm ci --prod
+
+      - run: "git config --global user.email 'changelog@github.com'"
+      - run: "git config --global user.name 'Awesome Github action'"
+
+      - run: git tag | xargs git tag -d
+      - name: Create fake tag
+        run: "git tag -a 'v0.55.8' -m 'v0.55.8'"
+      - run: "git add . && git commit -m 'fix: Added fake file so version will be bumped'"
+
+      - name: Generate changelog
+        id: changelog
+        uses: ./
+        env:
+          ENV: 'dont-use-git'
+          EXPECTED_TAG: 'v0.55.9'
+          SKIPPED_COMMIT: true
+          EXPECTED_NO_PUSH: true
+        with:
+          github-token: ${{ secrets.github_token }}
+          skip-commit: 'true'
+          git-push: 'false'
+
  test-yaml:
    runs-on: ubuntu-latest
    steps:
@ -170,7 +224,11 @@ jobs:
        with:
          path: "./"

+      - run: npm ci
+      - run: npm run build
+      - run: rm -rf node_modules
      - run: npm ci --prod
+
      - run: touch ./fake-file.log
      - run: "git config --global user.email 'changelog@github.com'"
      - run: "git config --global user.name 'Awesome Github action'"
@ -240,7 +298,11 @@ jobs:
        with:
          path: "./"

+      - run: npm ci
+      - run: npm run build
+      - run: rm -rf node_modules
      - run: npm ci --prod
+
      - run: touch ./fake-file.log
      - run: "git config --global user.email 'changelog@github.com'"
      - run: "git config --global user.name 'Awesome Github action'"
@ -278,7 +340,11 @@ jobs:
        with:
          path: "./"

+      - run: npm ci
+      - run: npm run build
+      - run: rm -rf node_modules
      - run: npm ci --prod
+
      - run: touch ./fake-file.log
      - run: "git config --global user.email 'changelog@github.com'"
      - run: "git config --global user.name 'Awesome Github action'"
@ -314,7 +380,11 @@ jobs:
        with:
          path: "./"

+      - run: npm ci
+      - run: npm run build
+      - run: rm -rf node_modules
      - run: npm ci --prod
+
      - run: touch ./fake-file.log
      - run: "git config --global user.email 'changelog@github.com'"
      - run: "git config --global user.name 'Awesome Github action'"
@ -350,7 +420,11 @@ jobs:
        with:
          path: "./"

+      - run: npm ci
+      - run: npm run build
+      - run: rm -rf node_modules
      - run: npm ci --prod
+
      - run: touch ./fake-file.log
      - run: "git config --global user.email 'changelog@github.com'"
      - run: "git config --global user.name 'Awesome Github action'"
@ -386,7 +460,11 @@ jobs:
        with:
          path: "./"

+      - run: npm ci
+      - run: npm run build
+      - run: rm -rf node_modules
      - run: npm ci --prod
+
      - run: touch ./fake-file.log
      - run: "git config --global user.email 'changelog@github.com'"
      - run: "git config --global user.name 'Awesome Github action'"
@ -425,7 +503,11 @@ jobs:
        with:
          path: "./"

+      - run: npm ci
+      - run: npm run build
+      - run: rm -rf node_modules
      - run: npm ci --prod
+
      - run: touch ./fake-file.log
      - run: "git config --global user.email 'changelog@github.com'"
      - run: "git config --global user.name 'Awesome Github action'"
@ -457,7 +539,11 @@ jobs:
        with:
          path: "./"

+      - run: npm ci
+      - run: npm run build
+      - run: rm -rf node_modules
      - run: npm ci --prod
+
      - run: touch ./fake-file.log
      - run: "git config --global user.email 'changelog@github.com'"
      - run: "git config --global user.name 'Awesome Github action'"
@ -491,7 +577,11 @@ jobs:
        with:
          path: "./"

+      - run: npm ci
+      - run: npm run build
+      - run: rm -rf node_modules
      - run: npm ci --prod
+
      - run: touch ./fake-file.log
      - run: "git config --global user.email 'changelog@github.com'"
      - run: "git config --global user.name 'Awesome Github action'"
@ -532,7 +622,11 @@ jobs:
        with:
          path: "./"

+      - run: npm ci
+      - run: npm run build
+      - run: rm -rf node_modules
      - run: npm ci --prod
+
      - run: touch ./fake-file.log
      - run: "git config --global user.email 'changelog@github.com'"
      - run: "git config --global user.name 'Awesome Github action'"
--- a/.gitignore
+++ b/.gitignore
@ -64,3 +64,6 @@ typings/

 # next.js build output
 .next
+
+# build output
+lib
--- a/README.md
+++ b/README.md
@ -9,6 +9,7 @@ This action will bump version, tag commit and generate a changelog with conventi
 - **Optional** `git-user-name`: The git user.name to use for the commit. Default `Conventional Changelog Action`
 - **Optional** `git-user-email`: The git user.email to use for the commit. Default `conventional.changelog.action@github.com`
 - **Optional** `git-pull-method`: The git pull method used when pulling all changes from remote. Default `--ff-only`
+- **Optional** `git-push`: Push all the GIT changes. Default `true`
 - **Optional** `preset`: Preset that is used from conventional commits. Default `angular`.
 - **Optional** `tag-prefix`: Prefix for the git tags. Default `v`.
 - **Optional** `output-file`: File to output the changelog to. Default `CHANGELOG.md`, when providing `'false'` no file will be generated / updated.
--- a/action.yml
+++ b/action.yml
@ -3,7 +3,7 @@ description: 'Bump version, tag commit and generates changelog with conventional
 author: 'Tycho Bokdam'
 runs:
  using: 'node12'
-  main: 'src/index.js'
+  main: 'lib/index.js'

 branding:
  icon: 'edit'
--- a/package-lock.json
+++ b/package-lock.json
@ -454,6 +454,12 @@
      "integrity": "sha512-//oorEZjL6sbPcKUaCdIGlIUeH26mgzimjBB77G6XRgnDl/L5wOnpyBGRe/Mmf5CVW3PwEBE1NjiMZ/ssFh4wA==",
      "dev": true
    },
+    "@vercel/ncc": {
+      "version": "0.31.1",
+      "resolved": "https://registry.npmjs.org/@vercel/ncc/-/ncc-0.31.1.tgz",
+      "integrity": "sha512-g0FAxwdViI6UzsiVz5HssIHqjcPa1EHL6h+2dcJD893SoCJaGdqqgUF09xnMW6goWnnhbLvgiKlgJWrJa+7qYA==",
+      "dev": true
+    },
    "JSONStream": {
      "version": "1.3.5",
      "resolved": "https://registry.npmjs.org/JSONStream/-/JSONStream-1.3.5.tgz",
@ -1182,9 +1188,9 @@
          }
        },
        "chalk": {
-          "version": "4.1.0",
-          "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.0.tgz",
-          "integrity": "sha512-qwx12AxXe2Q5xQ43Ac//I6v5aXTipYrSESdOgzrN+9XjgEpyjpKuvSGaN4qE93f7TQTlerQQ8S+EQ0EyDoVL1A==",
+          "version": "4.1.2",
+          "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz",
+          "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==",
          "dev": true,
          "requires": {
            "ansi-styles": "^4.1.0",
--- a/package.json
+++ b/package.json
@ -7,7 +7,8 @@
    "changelog",
    "commits",
    "conventional",
-    "github"
+    "github",
+    "conventional commits"
  ],
  "homepage": "https://github.com/TriPSs/conventional-changelog-action#readme",
  "bugs": {
@ -22,7 +23,11 @@
    "name": "Tycho Bokdam",
    "email": "tycho@palmtreecoding.com"
  },
-  "main": "src/index.js",
+  "main": "lib/index.js",
+  "scripts": {
+    "build": "ncc build src/index.js --minify --out lib",
+    "watch": "ncc build src/index.js --watch"
+  },
  "dependencies": {
    "@actions/core": "1.6.0",
    "@actions/exec": "1.1.0",
@ -37,6 +42,7 @@
  "devDependencies": {
    "@commitlint/cli": "13.2.0",
    "@commitlint/config-conventional": "13.2.0",
+    "@vercel/ncc": "^0.31.1",
    "husky": "4.3.6"
  }
 }
--- a/src/helpers/git.js
+++ b/src/helpers/git.js
@ -48,7 +48,7 @@ module.exports = new (class Git {
   * @param command
   * @return {Promise<>}
   */
-  exec = (command) => new Promise(async(resolve, reject) => {
+  exec = (command) => new Promise(async (resolve, reject) => {
    let execOutput = ''

    const options = {
@ -102,7 +102,7 @@ module.exports = new (class Git {
   *
   * @return {Promise<>}
   */
-  pull = async() => {
+  pull = async () => {
    const args = ['pull']

    // Check if the repo is unshallow
@ -130,7 +130,7 @@ module.exports = new (class Git {
   *
   * @return {Promise<>}
   */
-  isShallow = async() => {
+  isShallow = async () => {
    if (ENV === 'dont-use-git') {
      return false
    }
@ -161,7 +161,7 @@ module.exports = new (class Git {
   */
  testHistory = () => {
    if (ENV === 'dont-use-git') {
-      const { EXPECTED_TAG, SKIPPED_COMMIT } = process.env
+      const { EXPECTED_TAG, SKIPPED_COMMIT, EXPECTED_NO_PUSH } = process.env

      const expectedCommands = [
        'git config user.name "Conventional Changelog Action"',
@ -175,7 +175,10 @@ module.exports = new (class Git {
      }

      expectedCommands.push(`git tag -a ${EXPECTED_TAG} -m "${EXPECTED_TAG}"`)
+
+      if (!EXPECTED_NO_PUSH) {
        expectedCommands.push(`git push origin ${branch} --follow-tags`)
+      }

      assert.deepStrictEqual(
        this.commandsRun,