Skip to content

Commit

Permalink
feat: 'release/1.4.0'
Browse files Browse the repository at this point in the history
  • Loading branch information
Xeyos88 committed Dec 31, 2024
2 parents 3eb2e22 + 5d85a12 commit 588b470
Show file tree
Hide file tree
Showing 32 changed files with 17,520 additions and 4,994 deletions.
31 changes: 22 additions & 9 deletions .github/workflows/deploy.yml → .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Sample workflow for building and deploying a VitePress site to GitHub Pages
#
name: Deploy VitePress site to Pages
name: Release, Documentation and Publish

on:
# Runs on pushes targeting the `main` branch. Change this to `master` if you're
Expand All @@ -15,10 +15,12 @@ on:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
contents: write
issues: write
pages: write
id-token: write


# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
Expand Down Expand Up @@ -46,23 +48,34 @@ jobs:
uses: actions/configure-pages@v4
- name: Install dependencies
run: npm ci # or pnpm install / yarn install / bun install
- name: Run Tests
run: npm run test
- name: Build package
run: npm run build
- name: Build with VitePress
run: npm run docs:build # or pnpm docs:build / yarn docs:build / bun run docs:build
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: docs/.vitepress/dist
- name: Setup Git Identity
run: |
git config --global user.name 'github-actions[bot]'
git config --global user.email 'github-actions[bot]@users.noreply.github.com'
- name: Release
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
run: npx semantic-release
- name: Publish to NPM
if: github.event_name == 'release'
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
run: |
echo "//registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}" > ~/.npmrc
cat ~/.npmrc
npm publish
- name: Build with VitePress
run: npm run docs:build # or pnpm docs:build / yarn docs:build / bun run docs:build
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: docs/.vitepress/dist
# Deployment job
deploy:
Expand Down
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@ docs/.vitepress/dist

*.tgz

/coverage
junit.xml

#temporary
hy-vue-gantt-1.0.0.tgz

55 changes: 55 additions & 0 deletions .releaserc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
{
"branches": ["main"],
"plugins": [
"@semantic-release/commit-analyzer",
[
"@semantic-release/release-notes-generator",
{
"preset": "angular",
"writerOpts": {
"mainTemplate": "## [v{{version}}](https://github.com/Xeyos88/HyVueGantt/tree/v{{version}}) ({{date}})\n\n[Full Changelog](https://github.com/Xeyos88/HyVueGantt/{{previousTag}}...v{{version}})\n\n{{> header}}\n\n{{#each commitGroups}}\n{{#if title}}\n### {{title}}\n\n{{/if}}\n{{#each commits}}\n{{> commit root=@root}}\n{{/each}}\n{{/each}}\n\n{{> footer}}",
"headerPartial": "",
"commitPartial": "- {{#if scope}}**{{scope}}:** {{/if}}{{subject}}\n",
"footerPartial": "{{> noteGroups}}",
"partials": {
"noteGroups": "- **Notes**:\n{{#each noteGroups}}\n - {{this}}\n{{/each}}"
}
},
"presetConfig": {
"types": [
{ "type": "feat", "section": "✨ New Feature" },
{ "type": "fix", "section": "🐛 Fix" },
{ "type": "perf", "section": "⚡️ Performance" },
{ "type": "docs", "section": "📚 Documentation" },
{ "type": "style", "section": "💄 Style" },
{ "type": "refactor", "section": "♻️ Refactoring" },
{ "type": "test", "section": "✅ Test" },
{ "type": "build", "section": "👷 Build" },
{ "type": "ci", "section": "🔧 CI" }
]
}
}
],
[
"@semantic-release/changelog",
{
"changelogTitle": "# Changelog\n\nAll notable changes to this project will be documented in this file.\n\n---"
}
],
[
"@semantic-release/npm",
{
"npmPublish": false
}
],
[
"@semantic-release/git",
{
"assets": ["package.json", "CHANGELOG.md"],
"message": "chore(release): {{nextRelease.version}} [skip ci]\n\n{{nextRelease.notes}}"
}
],
"@semantic-release/github"
],
"repositoryUrl": "https://github.com/Xeyos88/HyVueGantt"
}
56 changes: 55 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,59 @@
# Changelog

## [v1.3.0](https://github.com/Xeyos88/HyVueGantt/tree/v1.3.0) (2024-12-29)

[Full Changelog](https://github.com/Xeyos88/HyVueGantt/v1.2.0...v1.3.0)

**New Features:**

- Added milestone slots support. #milestone for all milestones, #milestone-${milestoneId} for specific milestone
- Added milestone definition per bar. Bars cannot exceed the milestone
- Added rowClass and rowLabelClass props. Custom methods to add classes in the data row and label row
- Added dayOptionLabel prop. Define different ways to visualize the day time unit (number, day, doy or name)

**Updates:**

- Added id field in Milestone type

**Fixed:**

- Fixed bar slot propagation
- Fixed sort event emit
- User precision is now the best displayed precision

## [v1.2.0](https://github.com/Xeyos88/HyVueGantt/tree/v1.2.0) (2024-12-25)

[Full Changelog](https://github.com/Xeyos88/HyVueGantt/v1.1.0...v1.2.0)

**New Features:**

- Milestone definition with tooltip and color schema
- Enable holiday highlight with tooltip and color schema

**Updates:**

- Auto change of precision if lower cells become too small for proper display
- Improved zoom feature

**Fixed:**

- Fixed bar connection after zoom

## [v1.1.0](https://github.com/Xeyos88/HyVueGantt/tree/v1.1.0) (2024-12-22)

[Full Changelog](https://github.com/Xeyos88/HyVueGantt/v1.0.1...v1.1.0)

**New Features:**

- Use multiple label columns pre-defined
- Sort rows based on label column
- Resizable label columns
- Define custom label columns

**Note:**

All features above are enabled with `labelColumnTitle` prop defined

## [v1.0.1](https://github.com/Xeyos88/HyVueGantt/tree/v1.0.1) (2024-12-19)

[Full Changelog](https://github.com/Xeyos88/HyVueGantt/v1.00...v1.0.1)
Expand All @@ -10,7 +64,7 @@

## [v1.0.0](https://github.com/Xeyos88/HyVueGantt/tree/v1.0.0) (2024-12-19)

**Firt version**
**First version**

- Feature: Complete TypeScript support with enhanced type definitions and inference
- Feature: Bars support connections with multiple styles ('bezier', 'straight', 'squared') and patterns ('solid', 'dot', 'dash', 'dashdot')
Expand Down
128 changes: 128 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
# Contributing to HyVue Gantt

We love your input! We want to make contributing to HyVue Gantt as easy and transparent as possible, whether it's:

- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
- Becoming a maintainer

## Development Process

We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.

1. Fork the repo and create your branch from `main`.
2. If you've added code that should be tested, add tests.
3. If you've changed APIs, update the documentation.
4. Ensure the test suite passes.
5. Make sure your code lints.
6. Issue that pull request!

## Any contributions you make will be under the MIT Software License

When you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. If you have any concerns, please contact the maintainers.

## Report bugs using GitHub's [issue tracker](https://github.com/Xeyos88/HyVueGantt/issues)

We use GitHub issues to track public bugs. Report a bug by opening a new issue. Write bug reports with detail, background, and sample code.

**Great Bug Reports** should include:

- A quick summary and/or background
- Steps to reproduce
- Be specific
- Give sample code if you can
- What you expected would happen
- What actually happens
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

## Development Setup

1. Clone your fork of the repo

```sh
git clone https://github.com/Xeyos88/HyVueGantt.git
```

2. Install dependencies

```sh
npm install
```

3. Start development server

```sh
npm run dev
```

4. Create a branch for your feature
```sh
git checkout -b feature/my-new-feature
```

## Testing

We use Vitest for unit testing. All tests should pass before submitting a pull request.

```sh
npm run test
```

## Code Style and Linting

We use ESLint and Prettier to maintain code quality and consistency.

- Follow TypeScript best practices
- Use Vue 3 Composition API
- Follow the existing code style
- Write descriptive commit messages

Run linting:

```sh
npm run lint
```

## Pull Request Process

1. Update the README.md with details of changes to the interface, if applicable.
2. Update documentation in the `/docs` folder for new features or changes.
3. The PR will be merged once you have the sign-off of at least one maintainer.

## Documentation Guidelines

When adding new features, please include:

- TypeScript interfaces and types
- Description of the feature
- Example usage code
- Note any breaking changes
- Update relevant sections in `/docs`

## Versioning

We use [SemVer](http://semver.org/) for versioning. For new releases:

- MAJOR version for incompatible API changes
- MINOR version for backwards-compatible functionality additions
- PATCH version for backwards-compatible bug fixes

## Community and Behavioral Expectations

This project adheres to the [Contributor Covenant](http://contributor-covenant.org/version/1/3/0/) code of conduct. By participating, you are expected to uphold this code.

## License

By contributing, you agree that your contributions will be licensed under its MIT License.

## Questions or Need Help?

Feel free to:

- Open an issue with the question label
- Contact the maintainers
- Join our discussions on GitHub

Thank you for contributing to HyVue Gantt!
Loading

0 comments on commit 588b470

Please sign in to comment.