Whitelist files to publish + new GitHub workflow to auto tag / release / publish

[MrChocolatine]

Build

Whitelist files to include on publish (#153)

To reduce the final bundle size.

Before (see workflow run)	After (see workflow run)
npm notice === Tarball Details === npm notice package size: 7.8 kB npm notice unpacked size: 21.7 kB npm notice total files: 22	npm notice === Tarball Details === npm notice package size: 6.7 kB npm notice unpacked size: 18.4 kB npm notice total files: 18

CI

New GitHub workflow to automatically create a new tag, a new release and publish to NPM (#153)

Anytime something is merged to master, this new workflow will be triggered:

1. If a new version is detected (based on the version entry of the package.json), it is used to create a new git tag.

2. A new GitHub release is created, based on this tag ⬆️

3. The add-on is published to NPM

[GreatWizard]

Form your dry run :

npm notice 0 addon/.gitkeep
npm notice 0 app/.gitkeep
npm notice 79B app/initializers/embedded.js
npm notice 88B app/instance-initializers/embedded.js
npm notice 63B app/services/embedded.js
npm notice 87B config/environment.js
npm notice 615B index.js
npm notice 4.0kB package.json
npm notice 1.2kB tsconfig.json
npm notice 1.1kB LICENSE.md
npm notice 363B app/README.md
npm notice 5.5kB README.md
npm notice 240B initializers/embedded.d.ts
npm notice 246B instance-initializers/embedded.d.ts
npm notice 354B services/embedded.d.ts
npm notice 3.0kB addon/initializers/embedded.ts
npm notice 379B addon/instance-initializers/embedded.ts
npm notice 851B addon/services/embedded.ts
npm notice 199B types/global.d.ts
npm notice 126B types/dummy/index.d.ts

I think we can keep the npmignore to remove the .gitkeep files
and same about the readme.md ? I don't think anyone is gonna read it from node_modules tbh

[MrChocolatine]

I think we can keep the npmignore to remove the .gitkeep files

I thought about that but when I made some tests when having a .npmignore that ignores .gitkeep files and the entry files in the package.json, the .gitkeep files were still included in the output.

And because .gitkeep files size is 0 bytes, I thought it would not be a big deal to actually keep them.

[MrChocolatine]

and same about the readme.md ? I don't think anyone is gonna read it from node_modules tbh

This file, and some others, are always and automatically included during the publish, no matter what settings we use. (I also wanted to ignore it at first...)

https://docs.npmjs.com/cli/v6/configuring-npm/package-json#files

[MrChocolatine]

As a reminder about what is going to happen, "what will be included in the publish?".

Initially, when this PR started and we did not have this entry package.json/files, but only our .npmignore, the files included in the publish were:

https://github.com/peopledoc/ember-cli-embedded/runs/3941184198?check_suite_focus=true#step:5:17

npm notice === Tarball Contents ===
npm notice 22B   .github/CODEOWNERS
npm notice 79B   app/initializers/embedded.js
npm notice 88B   app/instance-initializers/embedded.js
npm notice 63B   app/services/embedded.js
npm notice 87B   config/environment.js
npm notice 615B  index.js
npm notice 3.8kB package.json
npm notice 1.2kB tsconfig.json
npm notice 1.1kB LICENSE.md
npm notice 363B  app/README.md
npm notice 5.5kB README.md
npm notice 240B  initializers/embedded.d.ts
npm notice 246B  instance-initializers/embedded.d.ts
npm notice 354B  services/embedded.d.ts
npm notice 3.0kB addon/initializers/embedded.ts
npm notice 379B  addon/instance-initializers/embedded.ts
npm notice 851B  addon/services/embedded.ts
npm notice 199B  types/global.d.ts
npm notice 126B  types/dummy/index.d.ts
npm notice 2.1kB .github/workflows/ci.yml
npm notice 691B  .github/dependabot.yml
npm notice 683B  .github/workflows/publish-npm.yml

Some files of these files are always and automatically included during a publish, no matter what settings we apply (this is a rule from npm itself, we can't do anything):

https://docs.npmjs.com/cli/v6/configuring-npm/package-json#files

package.json
README
CHANGES / CHANGELOG / HISTORY
LICENSE / LICENCE
NOTICE
The file in the "main" field

Now, if we apply this rule from npm to our initial list of files + our whitelist from package.json/files, we should end up with:

npm notice === Tarball Contents ===
npm notice 79B   app/initializers/embedded.js
npm notice 88B   app/instance-initializers/embedded.js
npm notice 63B   app/services/embedded.js
npm notice 87B   config/environment.js
npm notice 615B  index.js
npm notice 3.8kB package.json
npm notice 1.2kB tsconfig.json
npm notice 1.1kB LICENSE.md
npm notice 363B  app/README.md
npm notice 5.5kB README.md
npm notice 240B  initializers/embedded.d.ts
npm notice 246B  instance-initializers/embedded.d.ts
npm notice 354B  services/embedded.d.ts
npm notice 3.0kB addon/initializers/embedded.ts
npm notice 379B  addon/instance-initializers/embedded.ts
npm notice 851B  addon/services/embedded.ts
npm notice 199B  types/global.d.ts
npm notice 126B  types/dummy/index.d.ts

[MrChocolatine]

See the results of the previous commit, before the current final state:

• Run of the workflow
  https://github.com/peopledoc/ember-cli-embedded/actions/runs/1366939634

• The resulting GitHub release
  https://github.com/peopledoc/ember-cli-embedded/releases/tag/v2.2.0-alpha.0

• The resulting git tag
  https://github.com/peopledoc/ember-cli-embedded/tree/v2.2.0-alpha.0