Skip to content

Commit

Permalink
Add link to download to changelog [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
SRGDamia1 committed Dec 15, 2020
1 parent 04f9d68 commit ec94304
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 29 deletions.
12 changes: 7 additions & 5 deletions .github/workflows/prepare_release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@ jobs:
run: |
echo "::debug::Get the current version number"
VER=$(cat VERSION)
ZIP_FILE="ModularSensors_Dependencies_${VER}""
echo "VERSION=$VER" >> $GITHUB_ENV
echo "ZIP_NAME=$ZIP_FILE" >> $GITHUB_ENV
- name: Restore or Cache pip
uses: actions/cache@v2
Expand Down Expand Up @@ -154,15 +156,15 @@ jobs:
echo "::debug::Listing global libraries"
pio lib -g list
echo "::debug::Zipping global libraries"
zip ModularSensors_Dependencies.zip -r ~/.platformio/lib
zip ${{ env.ZIP_NAME }}.zip -r ~/.platformio/lib
# Remove some extras from the zip
- name: Remove git files from the zip
continue-on-error: true
run: |
echo "::debug::Deleting extra files to decrease size of zip"
echo "::debug::Removing Git folders"
zip -d -q ModularSensors_Dependencies "*/.gitattributes" "*/.gitignore" "*/.gitmodules" "*/.github/*" "*.sh" "*/Doxyfile" "*/.travis.yml"
zip -d -q ${{ env.ZIP_NAME }} "*/.gitattributes" "*/.gitignore" "*/.gitmodules" "*/.github/*" "*.sh" "*/Doxyfile" "*/.travis.yml"
- name: Remove other pdfs from the zip
continue-on-error: true
run: |
Expand Down Expand Up @@ -201,7 +203,7 @@ jobs:
with:
tag_name: ${{ env.VERSION }}
release_name: ${{ env.VERSION }}
draft: true
draft: false
prerelease: false
body: ${{join(fromJson(steps.generate_notes.outputs.notes).notes, '')}}

Expand All @@ -213,8 +215,8 @@ jobs:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
upload_url: ${{ steps.create_release.outputs.upload_url }} # This pulls from the CREATE RELEASE step above, referencing it's ID to get its outputs object, which include a `upload_url`. See this blog post for more info: https://jasonet.co/posts/new-features-of-github-actions/#passing-data-to-future-steps
asset_path: ./ModularSensors_Dependencies.zip
asset_name: ModularSensors_Dependencies.zip
asset_path: ${{format('./{0}.zip', env.ZIP_NAME)}}
asset_name: ${{format('{0}.zip', env.ZIP_NAME)}}
asset_content_type: application/zip

# Publish the new release to the pio package manager
Expand Down
34 changes: 10 additions & 24 deletions ChangeLog.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## v0.27.5 (2020-12-15)

## Multiple new Sensors and Workflows
## [Multiple new Sensors and Workflows](https://github.com/EnviroDIY/ModularSensors/releases/tag/v0.27.5)

### Downloads

**[ModularSensors_Dependencies_0.27.5.zip](https://github.com/EnviroDIY/ModularSensors/releases/download/v0.27.5/ModularSensors_Dependencies_0.27.5.zip)** contains this version of ModularSensors _and the proper versions of all of its dependencies_.

### New Features:

Expand Down Expand Up @@ -42,20 +46,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## v0.25.0

## v0.25.0: Styling & Doxygen Code Documentation
## [v0.25.0: Styling & Doxygen Code Documentation](https://github.com/EnviroDIY/ModularSensors/releases/tag/v0.25.0)

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3908530.svg)](https://doi.org/10.5281/zenodo.3908530)

### Downloads

**[libraries_v0.25.0.zip](https://github.com/EnviroDIY/ModularSensors/releases/download/v0.25.0/libraries_v0.25.0.zip)** contains this version of ModularSensors _and the proper versions of all of its dependencies_.

#### Installing on the Arduino IDE:
In your the Arduino Software (IDE), import the library zip file following the instructions for "Manual Installation" from https://www.arduino.cc/en/Guide/Libraries#toc5. You cannot directly import the zip using the Arduino Library Manager because it contains multiple libraries.

#### Installing for PlatformIO:
Extract the contents of library zip to your project's 'lib' folder.

### New Features:
- Automated code documentation using [Doxygen](https://www.doxygen.nl/index.html), now available at https://envirodiy.github.io/ModularSensors/

Expand All @@ -78,41 +76,29 @@ For more details, see [Pull Request #309: The style sheet](https://github.com/En

## v0.24.1

## v0.24.1: Modem Restructuring
## [v0.24.1: Modem Restructuring](https://github.com/EnviroDIY/ModularSensors/releases/tag/v0.24.1)

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3693784.svg)](https://doi.org/10.5281/zenodo.3693784)

## Downloads

**[libraries_v0.24.1.zip](https://github.com/EnviroDIY/ModularSensors/releases/download/v0.24.1/libraries_v0.24.1.zip)** contains this version of ModularSensors _and the proper versions of all of its dependencies_.

#### Installing on the Arduino IDE:
In your the Arduino Software (IDE), import the library zip file following the instructions for "Manual Installation" from https://www.arduino.cc/en/Guide/Libraries#toc5. You cannot directly import the zip using the Arduino Library Manager because it contains multiple libraries.

#### Installing for PlatformIO:
Extract the contents of library zip to your project's 'lib' folder.

### Improvements

Restructured modem so that it no longer operates as a sensor. Variables tied to the modem are now effectively calculated variables and all values from the modem will be offset by 1 sending cycle (ie, the signal strength posted will always be the strength from the prior send, not the current one).


## v0.23.13

## v0.23.13: More agressive attempts to set clock
## [v0.23.13: More agressive attempts to set clock](https://github.com/EnviroDIY/ModularSensors/releases/tag/v0.23.13)

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3451413.svg)](https://doi.org/10.5281/zenodo.3451413)

## Downloads

**[libraries_v0.23.13.zip](https://github.com/EnviroDIY/ModularSensors/releases/download/v0.23.13/libraries_v0.23.13.zip)** contains this version of ModularSensors _and the proper versions of all of its dependencies_.

#### Installing on the Arduino IDE:
In your the Arduino Software (IDE), import the library zip file following the instructions for "Manual Installation" from https://www.arduino.cc/en/Guide/Libraries#toc5. You cannot directly import the zip using the Arduino Library Manager because it contains multiple libraries.

#### Installing for PlatformIO:
Extract the contents of library zip to your project's 'lib' folder.

### Improvements:
- Much more aggressive attempts to set the clock if the time is not reasonable - before 01Sep2019 or after 01Jan2025.
- The LED will flicker and warnings will be sent over the serial port for invalid times at every check.
Expand All @@ -123,7 +109,7 @@ Extract the contents of library zip to your project's 'lib' folder.

## v0.23.11

## v0.23.11: Watchdogs and More
## [v0.23.11: Watchdogs and More](https://github.com/EnviroDIY/ModularSensors/releases/tag/v0.23.11)

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3405562.svg)](https://doi.org/10.5281/zenodo.3405562)

Expand Down Expand Up @@ -160,7 +146,7 @@ Extract the contents of libraries.zip to your project's 'lib' folder.

## v0.22.5

## v0.22.5: Modem Simplification
## [v0.22.5: Modem Simplification](https://github.com/EnviroDIY/ModularSensors/releases/tag/v0.22.5)

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3255084.svg)](https://doi.org/10.5281/zenodo.3255084)

Expand Down

0 comments on commit ec94304

Please sign in to comment.