Skip to content

docs(workflow): add Git Flow and npm version requirements #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
Zaiidmo merged 1 commit into from
Jan 31, 2026
Merged

docs(workflow): add Git Flow and npm version requirements #6

Zaiidmo merged 1 commit into from
Jan 31, 2026

Conversation

@Zaiidmo
Copy link
Contributor

@Zaiidmo Zaiidmo commented Jan 31, 2026

  • Add Git Flow branching strategy (develop/master)
  • Document npm version command before push
  • Add prepublishOnly hook recommendation
  • Update workflow with proper branch management
  • Clear warnings about PR targeting

@RedaChannaCiscode
docs(workflow): add Git Flow and npm version requirements
ee7474a 
- Add Git Flow branching strategy (develop/master)
- Document npm version command before push
- Add prepublishOnly hook recommendation
- Update workflow with proper branch management
- Clear warnings about PR targeting
Copilot AI review requested due to automatic review settings January 31, 2026 18:33
Copilot AI reviewed Jan 31, 2026
View reviewed changes
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds comprehensive Git Flow branching strategy documentation and npm version management guidelines for the authentication-kit module development workflow.

Changes:

  • Introduces Git Flow with develop/master branch structure and feature/bugfix branch naming conventions
  • Documents mandatory npm version commands before pushing changes
  • Adds prepublishOnly hook recommendation for automated pre-publish validation

@Zaiidmo Zaiidmo merged commit a419adb into develop Jan 31, 2026
1 check passed
@Zaiidmo Zaiidmo deleted the docs/git-flow-and-version-bump branch January 31, 2026 18:36
Zaiidmo added a commit that referenced this pull request Jan 31, 2026
@Ciscode-Admin @Zaiidmo @RedaChannaCiscode
Develop (#7)
fd136e9 
* refactor: create services files for further SoC

* refactor: update authKit Module to not ever call any db, and delete client model

* refactor: create repositories files for further SoC

* refactor: create proper package json file #deleted unnecessary matters

* refactor: update database models and packages configs

* refactor: create DTOs files

* refactor: update register dto

* refactor: remove business logic from auth controller

* refactor: update user model

* refactor: create an auth business logic service file

* refactor: create user repository file, for db interaction;

* refactor: add alias paths to tsconfig

* refactor: create mail service

* refactor: update authservice and remove all client references from the password reset files

* refactor: Update the authentication guard, and wiring new implementations into Kit module

* refactor: create admin user-management controller

* refactor: delete duplicated auth middleware

* refactor: create user-management repository

* refactor: create user-management admin servie

* refactor: create role-update dto
;

* refactor: separating DTOs folder, create roles&permissions DTOs

* refactor: create roles & permissions HTTP controllers

* refactor: create roles & permissions Repositories

* refactor: delete unnecessary unused files

* refactor: create role middleware and admin decorator, alongside default roles and permissions seeder

* refactor: create roles & seed services, and update user roles

* refactor: delete password reset controller, create roles & permissions controllers and update users controller

* refactor: update role dto
;

* refactor: updated roles repository

* refactor: wiring updates in authkitModule and exporting needed exports for host apps

* refactor: delete db config (unneded), and setting up default role assigning methods

* refactor: create admin guard and update the service and decorator

* refactor: wiring and exporting new admin service & guard

* refactor: exporting admin providers in auth kit module, updated env variables retrieval in auth service, added a simple log for admin Id after seeds run

* refactor: removing unnecessary types

* refactor: created oAuth Service

* refactor: added OAuth endpoints for all providers

* refactor: updated passport strategy

* updated authentication middleware and auth controller with OAUth endpoint

* created oauth service and updated auth service

* wiring all new implementations into authkit module

* doc: update readme file

* refactor: Secure auth routes

* refactor: register oAuth Strategy once the module in init

* refactor: create a new .envexample

* refactor: fix build errors withing typescript stricts

* refactor: fix dependencies misInstallation

* refactor: update userModel to pass null PhoneNumberValues

* refactor: update user repository to have a proper password finding method

* refactor: enhance auth service for login paths

* refactor: fix peerDependencies issues

* refactor: Update OAuth strategies

* refactor: adjust the auth controller and models for OAuth fix

* DOC: Update Readme documentation#

* refactor: update user model to contain new fields, and omitting username for unnecessary use

* feat: implement comprehensive error handling system

Added GlobalExceptionFilter and LoggerService for centralized error handling.
Replaced all generic Error throws with proper NestJS HTTP exceptions.

* chore create new user service funcion to retrieve user data

* chore: added users `me` end point

* docs: updated README doc for new endpoint implementation

* docs(workflow): add Git Flow and npm version requirements (#6)

- Add Git Flow branching strategy (develop/master)
- Document npm version command before push
- Add prepublishOnly hook recommendation
- Update workflow with proper branch management
- Clear warnings about PR targeting

Co-authored-by: Reda Channa <r.channa@ciscod.com>

* docs: translate italian text to english and add comprehensive documentation

- Translate all Italian text in copilot-instructions.md to English
- Add CHANGELOG.md with complete version history and roadmap
- Add SECURITY.md with vulnerability reporting and best practices
- Add TROUBLESHOOTING.md with 60+ common issues and solutions
- Enhance CONTRIBUTING.md with module-specific development guide
- Remove old SECURITY file (replaced with SECURITY.md)

Documentation is now 100% English and production-ready.

* 1.5.1

---------

Co-authored-by: Zaiidmo <zaiidmoumnii@gmail.com>
Co-authored-by: Zaiid Moumni <141942826+Zaiidmo@users.noreply.github.com>
Co-authored-by: Reda Channa <r.channa@ciscod.com>
Zaiidmo added a commit that referenced this pull request Feb 1, 2026
@Zaiidmo @RedaChannaCiscode
Develop (#8)
a7bcbd3 
* refactor: create services files for further SoC

* refactor: update authKit Module to not ever call any db, and delete client model

* refactor: create repositories files for further SoC

* refactor: create proper package json file #deleted unnecessary matters

* refactor: update database models and packages configs

* refactor: create DTOs files

* refactor: update register dto

* refactor: remove business logic from auth controller

* refactor: update user model

* refactor: create an auth business logic service file

* refactor: create user repository file, for db interaction;

* refactor: add alias paths to tsconfig

* refactor: create mail service

* refactor: update authservice and remove all client references from the password reset files

* refactor: Update the authentication guard, and wiring new implementations into Kit module

* refactor: create admin user-management controller

* refactor: delete duplicated auth middleware

* refactor: create user-management repository

* refactor: create user-management admin servie

* refactor: create role-update dto
;

* refactor: separating DTOs folder, create roles&permissions DTOs

* refactor: create roles & permissions HTTP controllers

* refactor: create roles & permissions Repositories

* refactor: delete unnecessary unused files

* refactor: create role middleware and admin decorator, alongside default roles and permissions seeder

* refactor: create roles & seed services, and update user roles

* refactor: delete password reset controller, create roles & permissions controllers and update users controller

* refactor: update role dto
;

* refactor: updated roles repository

* refactor: wiring updates in authkitModule and exporting needed exports for host apps

* refactor: delete db config (unneded), and setting up default role assigning methods

* refactor: create admin guard and update the service and decorator

* refactor: wiring and exporting new admin service & guard

* refactor: exporting admin providers in auth kit module, updated env variables retrieval in auth service, added a simple log for admin Id after seeds run

* refactor: removing unnecessary types

* refactor: created oAuth Service

* refactor: added OAuth endpoints for all providers

* refactor: updated passport strategy

* updated authentication middleware and auth controller with OAUth endpoint

* created oauth service and updated auth service

* wiring all new implementations into authkit module

* doc: update readme file

* refactor: Secure auth routes

* refactor: register oAuth Strategy once the module in init

* refactor: create a new .envexample

* refactor: fix build errors withing typescript stricts

* refactor: fix dependencies misInstallation

* refactor: update userModel to pass null PhoneNumberValues

* refactor: update user repository to have a proper password finding method

* refactor: enhance auth service for login paths

* refactor: fix peerDependencies issues

* refactor: Update OAuth strategies

* refactor: adjust the auth controller and models for OAuth fix

* DOC: Update Readme documentation#

* refactor: update user model to contain new fields, and omitting username for unnecessary use

* feat: implement comprehensive error handling system

Added GlobalExceptionFilter and LoggerService for centralized error handling.
Replaced all generic Error throws with proper NestJS HTTP exceptions.

* chore create new user service funcion to retrieve user data

* chore: added users `me` end point

* docs: updated README doc for new endpoint implementation

* docs(workflow): add Git Flow and npm version requirements (#6)

- Add Git Flow branching strategy (develop/master)
- Document npm version command before push
- Add prepublishOnly hook recommendation
- Update workflow with proper branch management
- Clear warnings about PR targeting

Co-authored-by: Reda Channa <r.channa@ciscod.com>

* docs: translate italian text to english and add comprehensive documentation

- Translate all Italian text in copilot-instructions.md to English
- Add CHANGELOG.md with complete version history and roadmap
- Add SECURITY.md with vulnerability reporting and best practices
- Add TROUBLESHOOTING.md with 60+ common issues and solutions
- Enhance CONTRIBUTING.md with module-specific development guide
- Remove old SECURITY file (replaced with SECURITY.md)

Documentation is now 100% English and production-ready.

* 1.5.1

* chore: upgrade dependencies to latest versions

- Upgraded NestJS from 10.x to 11.1.12
- Upgraded Mongoose from 7.x to 9.1.5
- Upgraded nodemailer from 6.x to 7.0.13 (fixes DoS vulnerabilities)
- Upgraded TypeScript from 5.6.x to 5.7.3
- Upgraded axios from 1.7.7 to 1.13.4
- Upgraded semantic-release to 25.0.3
- Upgraded other dependencies to latest versions
- Fixed all production security vulnerabilities
- Build verified successful with all upgrades

* 1.5.3

---------

Co-authored-by: Reda Channa <r.channa@ciscod.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Zaiidmo @RedaChannaCiscode