Objective

Obtain information about npm publish workflow, having in mind its source code will be stored in GitHub (which has special integrations with npm) and work on a test project to find best practices for an automated npm package workflow.

Description

Having in mind semantic-release complexity as well as releases in Github as well as Npm sites, the best option to have good results (using the proposd gitflow in #6), is to create a test repository with some basic code, deploy such repository in npm and github as well as integrating semantic release to automate releases giving branch version or any alternative achived during learning process.

Tasks

• Read needed npm related documentation
• Read Github documentation related to npm integration
• Create test repository
• Create npm package and add needed data
• Copy codebase from Create initial project #5
• Integrate semantic-relaese
• Achieve a patch release in npm and github at same time (as 0.0.2) with semantic-release
• Achieve a minor release in npm and github at same time (as 0.1.0) with semantic-release
• Achieve a major release in npm and github at same time (as 2.0.0) with semantic-release
• Integrate semantic-release Github Action using a .yml file and default configuration
• Achieve custom branching management on semantic-release configuration
• Achieve version sync between package.json, git release and npm version (see specific configuration for that)

Ticket relationships

Technical notes

The used links on this investigations are the following:

• Npm registry docs
• Working with GitHub and Npm
• Semantic-release resources
• [Video] First steps by Bayan Bennett
• [Video] Semantic-release by Bayan Bennett
• [Video] Creating a npm package by James Q Quick
• [Video] Creating a npm package by DesignCourse
• [Video] How to implement Semantic Release by Bruno Antunes
• [Video] Automate your GitHub Actions Releases by Dave's Dev Channel