Skip to content

Commit 33a9040

Browse files
landonwjohnsonlandonwjohnson
committed
ready
1 parent 527b9f3 commit 33a9040

File tree

6 files changed

+166
-18
lines changed

6 files changed

+166
-18
lines changed

‎.DS_Store‎

0 Bytes
Binary file not shown.

‎Github/actions/publish.yml‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
name: Test and Publish on Merge
2+
3+
on:
4+
pull_request:
5+
branches:
6+
- main # Only runs on pull requests targeting the main branch
7+
types:
8+
- closed # Only trigger when the pull request is closed (merged or not)
9+
10+
jobs:
11+
test-and-publish:
12+
if: github.event.pull_request.merged == true && github.event.pull_request.base.ref == 'main'
13+
runs-on: ubuntu-latest
14+
15+
steps:
16+
# Checkout the repository
17+
- uses: actions/checkout@v2
18+
19+
# Set up Node.js environment
20+
- name: Set up Node.js
21+
uses: actions/setup-node@v2
22+
with:
23+
node-version: '18'
24+
registry-url: 'https://registry.npmjs.org/'
25+
26+
# Install dependencies
27+
- name: Install dependencies
28+
run: npm install
29+
30+
# Run tests
31+
- name: Run Tests
32+
run: npm test
33+
34+
# Generate Changelog
35+
- name: Generate Changelog
36+
run: npx conventional-changelog -p angular -i CHANGELOG.md -s
37+
38+
# Commit Changelog changes if any
39+
- name: Commit Changelog
40+
run: |
41+
git config --global user.name "github-actions[bot]"
42+
git config --global user.email "github-actions[bot]@users.noreply.github.com"
43+
git add CHANGELOG.md
44+
git commit -m "chore(release): update changelog" || echo "No changes to commit"
45+
git push origin main
46+
47+
# Get version from package.json
48+
- name: Get Version from package.json
49+
id: get_version
50+
run: echo "VERSION=$(node -p \"require('./package.json').version\")" >> $GITHUB_ENV
51+
52+
# Create GitHub Release
53+
- name: Create GitHub Release
54+
uses: softprops/action-gh-release@v1
55+
with:
56+
tag_name: v${{ env.VERSION }}
57+
name: Release v${{ env.VERSION }}
58+
body_path: CHANGELOG.md
59+
env:
60+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
61+
62+
# Publish to NPM
63+
- name: Publish to NPM
64+
run: npm publish
65+
env:
66+
NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTOMATION_TOKEN }}

‎Github/actions/test.yml‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: Test and Publish on Merge
2+
3+
on:
4+
pull_request:
5+
branches:
6+
- main # Only runs on pull requests targeting the main branch
7+
types:
8+
- closed # Only trigger when the pull request is closed (merged or not)
9+
10+
jobs:
11+
test-and-publish:
12+
if: github.event.pull_request.merged == true && github.event.pull_request.base.ref == 'main' # Only runs if the PR was merged and only on PRs to the main branch
13+
runs-on: ubuntu-latest
14+
15+
steps:
16+
# Checkout the repository
17+
- uses: actions/checkout@v2
18+
19+
# Set up Node.js environment
20+
- name: Set up Node.js
21+
uses: actions/setup-node@v2
22+
with:
23+
node-version: '18'
24+
registry-url: 'https://registry.npmjs.org/'
25+
26+
# Install dependencies
27+
- name: Install dependencies
28+
run: npm install
29+
30+
# Run tests
31+
- name: Run Tests
32+
run: npm test
33+
34+
# Publish to NPM
35+
- name: Publish to NPM
36+
run: npm publish
37+
env:
38+
NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTOMATION_TOKEN }}

‎Github/github_labels_guide.md‎

Lines changed: 28 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -31,35 +31,45 @@ Priority labels help communicate how urgent or important a task is within the pr
3131
#### **Story Points Labels**
3232
Story points help estimate the effort or complexity required for a task.
3333

34+
---
35+
3436
- **Story Points: 1**
35-
- ⏳ **Hourglass**
36-
- **Description**: "For small, simple tasks that take minimal effort (1-2 hours)."
37-
- **Usage**: For tasks that can be completed quickly and easily.
37+
- ⏳ **Quick Task**
38+
- **Description**: *"For small, simple tasks that take minimal effort (up to 2 hours)."*
39+
- **Usage**: Use this for straightforward fixes, minor changes, or simple code tweaks (e.g., updating documentation, fixing typos, adjusting CSS styles).
3840

3941
- **Story Points: 2-3**
40-
- ⏳ **Hourglass**
41-
- **Description**: "For straightforward tasks requiring moderate effort (2-4 hours)."
42-
- **Usage**: For tasks that are slightly larger but still manageable.
42+
- ⏳ **Short Task**
43+
- **Description**: *"For straightforward tasks requiring moderate effort (2-4 hours)."*
44+
- **Usage**: Assign to tasks involving basic logic or small features (e.g., writing a new function, adding basic tests, or minor UI enhancements).
4345

4446
- **Story Points: 5**
45-
- ⏳ **Hourglass**
46-
- **Description**: "For tasks of medium complexity requiring several hours (5-8 hours)."
47-
- **Usage**: Assign to tasks that involve moderate complexity or effort.
47+
- ⏳ **Medium Task**
48+
- **Description**: *"For tasks of medium complexity requiring 5-8 hours."*
49+
- **Usage**: Suitable for moderately complex programming work (e.g., creating a reusable component, integrating an API, or adding state management logic).
4850

4951
- **Story Points: 8**
50-
- ⏳ **Hourglass**
51-
- **Description**: "For moderately complex tasks taking a full day (10-16 hours)."
52-
- **Usage**: Use for tasks that require significant time or effort.
52+
- ⏳ **Complex Task**
53+
- **Description**: *"For moderately complex tasks that could take 1-2 full days (8-16 hours)."*
54+
- **Usage**: Use for larger tasks like setting up authentication, handling complex form validation, or implementing advanced data-fetching strategies.
5355

5456
- **Story Points: 13**
55-
- ⏳ **Hourglass**
56-
- **Description**: "For complex tasks requiring multiple days (16+ hours)."
57-
- **Usage**: For tasks that involve greater complexity or need coordination across multiple parts of the project.
57+
- ⏳ **Large Task**
58+
- **Description**: *"For complex tasks that require multiple days (16+ hours)."*
59+
- **Usage**: Assign to substantial features, such as building a full CRUD module, setting up a notification system, or significant refactoring efforts.
5860

5961
- **Story Points: 20+**
60-
- ⏳ **Hourglass**
61-
- **Description**: "For large, multi-phase tasks or epics (40+ hours)."
62-
- **Usage**: For major tasks or project-spanning work requiring extensive planning and execution.
62+
- ⏳ **Epic Task**
63+
- **Description**: *"For large, multi-phase tasks or epics requiring 40+ hours (up to multiple weeks)."*
64+
- **Usage**: Suitable for full-scale projects or major overhauls, such as migrating an entire app to a new framework, rewriting core systems, or integrating third-party services with extensive testing.
65+
66+
67+
68+
69+
70+
71+
72+
6373

6474
#### **Difficulty Labels**
6575
These labels classify tasks by their complexity, guiding the team in understanding the level of challenge involved.

‎README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
## Purpose
2+
The purpose of this repository is to provide reusable documentation for various projects. It includes references for topics such as story points, SEO standards, folder structure, and general guidelines for organizing projects.

‎Releases/software_release_cycle.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Software Release Lifecycle
2+
3+
## Overview
4+
5+
In software development, the release lifecycle typically follows a structured progression through several stages. Understanding these stages helps teams manage the development process and communicate effectively with stakeholders.
6+
7+
### Stages of the Release Lifecycle
8+
9+
1. **Alpha**
10+
- This is an early version of the software that is often incomplete and may contain many bugs.
11+
- Alpha releases are primarily for internal testing by developers or select users.
12+
- The focus is on adding features and identifying major issues.
13+
14+
2. **Beta**
15+
- This stage follows alpha and is generally more stable than the alpha version.
16+
- Beta versions are often released to a wider audience for external testing.
17+
- The goal is to gather feedback, identify remaining bugs, and ensure the software works in various environments.
18+
19+
3. **Release Candidate (RC)**
20+
- After beta testing, if the software is stable enough, it may enter a release candidate stage.
21+
- This version is considered potentially final unless significant bugs are found.
22+
23+
4. **Stable Release**
24+
- The final version of the software that is ready for general use.
25+
26+
## Summary
27+
28+
The typical progression of software releases is:
29+
30+
**Alpha → Beta → Release Candidate → Stable Release**
31+
32+
This structured approach ensures that software is thoroughly tested and refined before it reaches the end users, improving overall quality and user satisfaction.

0 commit comments

Comments
 (0)