Skip to content

Commit

Permalink
Merge pull request #62 from artmg/dev
Browse files Browse the repository at this point in the history
v2023.3.27 release ready to include as HACS default repo
  • Loading branch information
artmg authored Mar 27, 2023
2 parents 140c4d4 + d21a8ab commit 2664038
Show file tree
Hide file tree
Showing 6 changed files with 68 additions and 15 deletions.
20 changes: 20 additions & 0 deletions .github/workflows/HACSvalidation.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# HACS validation Action as per https://hacs.xyz/docs/publish/action/

name: HACS validation

on:
push:
pull_request:
schedule:
- cron: "0 0 * * *"
workflow_dispatch:

jobs:
validate-hacs:
runs-on: "ubuntu-latest"
steps:
- uses: "actions/checkout@v3"
- name: HACS validation
uses: "hacs/action@main"
with:
category: "integration"
16 changes: 16 additions & 0 deletions .github/workflows/hassfest.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# hassfest validation action - see https://developers.home-assistant.io/blog/2020/04/16/hassfest/

name: Validate with hassfest

on:
push:
pull_request:
schedule:
- cron: "0 0 * * *"

jobs:
validate:
runs-on: "ubuntu-latest"
steps:
- uses: "actions/checkout@v3"
- uses: home-assistant/actions/hassfest@master
17 changes: 17 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,23 @@ Recent features from development that have not been formally released yet:
*


## 2023.3.27

Ready to include in HACS default repositories

### Added

* 03d09df use hassfest validation for HA custom_component compaibility checks
* 5b2ace6 Add HACS validate action to workflows
* df9d8cc more dev guidelines in CONTRIBUTING.md

### Fixed

* c8eb031 Clarify HACS validation in Actions
* 4820e4f removed invalid entries from hacs.json
*


## 2023.3.22

This is a bugfix release. The previous release had a broken HACS manifest.
Expand Down
19 changes: 13 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,6 @@ to work on your local project repository.

Please raise an issue if you want further guidance on developing new features or fixing issues.

Once you have completed your development and testing on your changes,
then please raise a Pull Request for us to be able to merge in your work. They should be merged into the **dev** branch.

### Project Structure

For the time being, contributors have settled on a
Expand All @@ -39,19 +36,29 @@ that includes:
* incorporating any changes to the API-related python code in warmup4ie subfolder
* and keeping a tracking copy in the root warmup4ie-PyPi folder for later

### Pull Requests

Once you have completed your development and testing on your changes,
then please raise a Pull Request for us to be able to merge in your work. They should be merged into the **`dev`** branch.

You will see some validation actions launched as part of our HACS compliance.
If any of these actions fail, then your Pull Request might be held back.

## Release

We use GitHub Releases as good practice, both for a github repo, and for a [HACS integration](https://hacs.xyz/docs/publish/integration/#github-releases-optional).
We use GitHub Releases as good practice, both for a github repo, and for a [HACS integration](https://hacs.xyz/docs/publish/integration/#github-releases-optional). Once the changes applied in the dev branch have been sufficiently tested, then they can be bundled up for a release into the `master` branch,

Before bringing changes into the **master** branch, please ensure that you have referenced the changes into [CHANGELOG.md](CHANGELOG.md) on dev. You could use `git log --oneline` to gather the info.

### Versioning

Since 2021.5.23, the versioning format has been YYYY.M.D (no leading zeroes). Note that HACS does not support the use of candidate suffixes - using a version like YYYY.M.D-beta may break the component.

When releasing a version, please ensure that you update the version in

```
custom_components/warmup/manifest.json
```

You may find it convenient to tag your release candidate. Since 2021.5.23, the versioning format has been YYYY.M.D (no leading zeroes). When raising the PR from your dev to the main project master, remember to ask for a new Github Releases to be created with the same tag.

You may find it convenient to tag your release candidate with the version. When raising the PR from your origin/dev to the main project master, remember to ask for a new Github Release to be created with the same tag.

2 changes: 1 addition & 1 deletion custom_components/warmup/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@
"iot_class": "cloud_polling",
"issue_tracker": "https://github.com/ha-warmup/warmup/issues/",
"requirements": [],
"version": "2023.03.22"
"version": "2023.3.27"
}
9 changes: 1 addition & 8 deletions hacs.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
{
"name": "Warmup under-floor heating integration",
"render_readme": false,
"domains": [
"climate"
],
"iot_class": [
"Cloud Polling"
]

"render_readme": false
}

0 comments on commit 2664038

Please sign in to comment.