@genesisx/git-workflows - npm Package Compare versions

Comparing version 0.0.1-beta-01 to 3.0.0-beta.0

package.json

 {
   "name": "@genesisx/git-workflows",
-  "version": "0.0.1-beta-01",
+  "version": "3.0.0-beta.0",
+  "license": "SEE LICENSE IN LICENSE",
+  "description": "This Generator is to easily setup git workflows for a Nx workspace.",
   "main": "src/index.js",
   "generators": "./generators.json",
   "executors": "./executors.json",
-  "typings": "./src/index.d.ts"
+  "types": "./src/index.d.ts"
 }

README.md

 # git-workflows
 
-This library was generated with [Nx](https://nx.dev).
+This is a generator for creating git workflow templates created for Genesis framework.
+This can be used in a non-genesis project as well, as no dependency on nx.
 
-## Building
+Following workflows are added to the Nx workspace when you execute this generator plugin.
 
-Run `nx build git-workflows` to build the library.
+**Nx Affected Apps**
+- This workflow has to be manually triggered as required.
+- Takes "Feature branch" and "Base Branch" as input as input.
+- Compare "Feature Branch" with the "Base Branch" to list out the apps that are affected with the changes made in the "Feature Branch"
+
+**Nx Affected Apps - Pull Request**
+- This workflow gets triggered when a pull request is opened for any feature branch.
+- Provides the following output
+- List of apps that are affected with the changes made in the feature branch
+- A template to unit test the apps that are affected with the changes
+- Provided dummy templates for workflow stages viz., Build Image, Publish Image
+
+**Nx Affected Apps - Master(Base Branch)**
+- This workflow gets triggered when a commit is pushed to base branch(When a PR is merged to the base branch).
+- Provides the following output
+- List of apps that are affected with the changes made in the latest commit
+- A template to unit test the apps that are affected with the changes
+- Provided dummy templates for workflow stages viz., Build Image, Publish Image
+
+**Nx Build App**
+- This workflow has to be manually triggered as required.
+- Takes "App name" as input.
+- Has templates to setup, test and build the app specified in the input while triggering.
+
+
+
+## Build & Publish
+
+**Publish "git-workflows "Plugin [Optional]**
+- Clone the Genesis Repository
+
+        - git clone https://pscode.lioncloud.net/psinnersource/xt/micro-frontend/genesis.git
+
+- Build the plugin generator
+
+        - nx run git-workflows:build
+
+- Publish the plugin generator to a registry
+
+        - npm publish ./dist/packages/git-workflows --registry [REGISTRY_URL]
+
+## Usage
+
+**Using "git-workflows" Plugin**
+- Create a new workspace
+
+        - npx create-nx-workspace@latest
+
+- Install the plugin
+
+        - npm install -D @genesisx/git-workflows@[VERSION] --registry [REGISTRY_URL]`
+
+- Execute the plugin
+Use NX GUI in VS to execute the workflow (or) Execute the following command
+
+        - `npx nx generate @genesisx/git-workflows:git-workflows --no-interactive `
+
+- Verify the generated workflows
+Verify if a new directory with name ".github" is created in the root of your workspace.
+Verify if the following files are created in the "./.github" directory of your workspace
+
+        - nx-affected-apps.yaml
+        - nx-affected-master.yaml
+        - nx-affected-pull-request.yaml
+        - nx-build-app.yaml
+

src/executors/build/schema.json

 {
+  "version": 2,
+  "outputCapture": "direct-nodejs",
   "$schema": "http://json-schema.org/schema",
@@ -3,0 +5,0 @@ "cli": "nx",

New alerts

Misc. License Issues

License

(Experimental) A package's licensing information has fine-grained problems.

Found 1 instance in 1 package

Fixed alerts

No License Found

License

(Experimental) License information could not be found.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

12400

increased by28.01%

Number of low license alerts

0

decreased by-100%

Lines of code

127

increased by1.6%

Number of lines in readme file

74

increased by825%

Worsened metrics

Number of medium license alerts

1

increased byInfinity%

No dependency changes