Skip to content

Template of README.MD file for Business Central projects

License

Notifications You must be signed in to change notification settings

ciellosinc/Ciellos-BC-git-flow-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

38 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Project name - Extension name

📣 General Information

This is a template for a Business Central project. Please complete it. Specify real names, numbers, and links.

The project is developed by a team of developers and is deployed to the following environments: Development, Test, UAT and Production. The project is managed using the Kanban board.
The project is based on the AL-Go Template, which automates the build and deployment process, making it easier for developers to focus on the development and reaching the end goal of publishing to AppSource.

🚂 Team

Role Description Full Name E-Mail Notifications
PM Project Manager Michelle Costello mcostello@contoso.com Yes
TA Technical Architect Milo Langworth mlangworth@contoso.com Yes
FC Functional Consultant Abigail West abigail.west@contoso.com No
DEV Developer Giovani Johnston giovani.johnston@contoso.com Yes
DEV Developer Addison Hermiston addison.hermiston@contoso.com No
SE/DevOps System Engineer/DevOps Larry Williams larry.williams@contoso.com Yes

🦄 Application

This Business Central Application has the following parameters:

Please use one code repository per Extension

📐 Object Ranges

  • App1 - { "from": 7XXXXXXX, "to": 7XXXXXXY }
  • App2 - { "from": 7XXXXXXX, "to": 7XXXXXXY }

📅 Object Prefix (Affix)

  • ABC

🍭 Other BC Applications in use

The customer is going to use the following extensions, including third-party ISV extensions:

Extension Description Link to download
Core solution Customer Core Extension with essential code https://github.com/ciellosinc/Ciellos-BC-git-flow-template
Master Data Sync Master Data Data between instances https://appsource.microsoft.com/en-us/marketplace/apps?search=master%20data&page=1&product=dynamics-365-business-central
Bank Bank Integration https://appsource.microsoft.com/en-us/marketplace/apps?search=bank&page=1&product=dynamics-365-business-central
Warehouse WHS https://appsource.microsoft.com/en-us/marketplace/apps?search=warehouse&page=1&product=dynamics-365-business-central

🖥️ Environments

Environment Branch Link Description
DEV feature/* Use local Docker-containers for development Dev box
Sandbox main https://businesscentral.dynamics.com/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/TEST Internal Testing
UAT release https://businesscentral.dynamics.com/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/UAT Customer's User Acceptance Test
PROD release https://businesscentral.dynamics.com/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/PROD Production - we have no access

🔬 Kanban board and Product Backlog

Board Status

🛂 Pipelines and Automation

Pipeline (Workflow) Name Trigger on Description
CI/CD on code push for branches: main, release/*, feature/* Build, Build Power Platform, Deploy ALDoc, Deploy to environments, Deliver.
Some steps may be skipped if they are not configured
Pull Request Build on PR for the main branch Make Code Validation
Test Next Minor Weekly Build the code against the Next Major version
Test Next Major Weekly and after each CI/CD pipeline on the main branch successfully completed Build the code against the Next Major version
Create release Manually only Prepare release notes, Create Release, Upload Artifacts (NuGet, Storage, GitHub), Create Release Branch, Update Version Number

🔔 Teams Channel

BC Implementation

🗿 Best Practices and other helpful information

Below, you can find the table of contents pointing to all the needed guides for Business Central development: