Skip to content

Commit

Permalink
Merge pull request #1183 from totaldebug/beta
Browse files Browse the repository at this point in the history
Merge beta to master
  • Loading branch information
marksie1988 authored Sep 27, 2023
2 parents cd4fe48 + 36c0fb4 commit b6be297
Show file tree
Hide file tree
Showing 26 changed files with 284 additions and 362 deletions.
3 changes: 3 additions & 0 deletions .devcontainer/post-install.sh
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ WORKSPACE_DIR=$(pwd)
# Now install all dependencies
yarn install

# Install Commitizen globally
npm install commitizen -g

# Install documentation dependencies
pip3 install -r docs/requirements.txt
pip3 install sphinx-autobuild pre-commit
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,6 @@ jobs:
run: yarn install

- name: Run Semantic Release
run: npx semantic-release@beta --debug
run: npx semantic-release --debug
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
<br />
<a href="https://github.com/totaldebug/atomic-calendar-revive/issues/new?assignees=&labels=type%2Fbug&template=bug_report.yml">Report Bug</a>
·
<a href="https://github.com/totaldebug/atomic-calendar-revive/issues/new?assignees=&labels=type%2Ffeature&template=feature_request.yml">Request Feature</a>
<a href="https://github.com/totaldebug/atomic-calendar-revive/discussions/categories/feature-requests">Request Feature</a>

</div>

Expand Down Expand Up @@ -139,7 +139,7 @@ Home Assistant 2022.5 will not work with the card you must upgrade to 2022.6
<!-- ROADMAP -->
## Roadmap

See the [feature requests](https://github.com/totaldebug/atomic-calendar-revive/labels/type%2Ffeature) for a full list of requested features.
See the [feature requests](https://github.com/totaldebug/atomic-calendar-revive/discussions/categories/feature-requests) for a full list of requested features.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

Expand Down
1 change: 1 addition & 0 deletions docs/configuration/event.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,6 @@ Event Mode Options
showEventDate boolean v7.1.0 ``true`` Show the event date
showDatePerEvent boolean v7.2.0 ``false`` Show the date next to each event entry
showTimeRemaining boolean v7.3.0 ``false`` Show the amount of time remaining for an event
hoursOnSameLine boolean v7.3.0 ``false`` if set true will move hours to show on the same line as the summary.
showAllDayHours boolean v7.5.0 ``true`` Show "All Day" text under full day events
======================= ========== ======== ===========================================================================================================
1 change: 0 additions & 1 deletion docs/configuration/main.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@ Main Options
hideFinishedEvents boolean optional v7.0.0 ``false`` if set true will hide any finished events
eventTitle string optional v7.3.0 Where no event title exists, add this string instead, Will add globally unless entity.eventTitle is set.
compactMode boolean optional v7.3.0 ``false`` if set true will squash text down to allow for much more compact design
hoursOnSameLine boolean optional v7.3.0 ``false`` if set true will move hours to show on the same line as the summary. NOTE using other options can mess up this style
language string optional unknown Not recommended to use, but can set the language code e.g. "gb" / "es"
titleLength integer optional v7.4.0 Sets the maximum length of the event titles
showAllDayEvents boolean optional ``true`` if set false will hide all events that are a full day
Expand Down
66 changes: 37 additions & 29 deletions docs/contribute/devcycle.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,28 +31,16 @@ from the main repository:
git remote add upstream https://github.com/totaldebug/atomic-calendar-revive
Checkout the master branch and pull the latest upstream version:
Checkout the beta branch and pull the latest upstream version:

.. code-block:: bash
git checkout master
git checkout beta
git fetch upstream
git merge upstream/master
git merge upstream/beta
git push
Your fork should now be in sync with the main totaldebug repository, now a new branch
is required for development.

.. code-block:: bash
git checkout -b <issue-number>_<feature/bug-name>
git checkout -b 100_Fix-the-bug
.. note::

The branch should have a relevant short name starting with the issue number
and then having a name for the fix / feature as shown in the example above.
Your fork should now be in sync with the main totaldebug repository.

********************
Install Dependencies
Expand All @@ -64,13 +52,16 @@ From the cloned repository, run the command to install the requirements:
yarn install
********************
Make changes & Build
********************
.. note::

If you are using VSCode devcontainer this happens as part of the post steps.

#. Any changes to the card should be made in the folder ``src``
#. Update the version number in ``package.json``
#. Run the command ``yarn run build`` to create the latest distribution file
************
Make changes
************

You are now ready to make changes to the code, all source code is in the ``src`` directory
there should be no need to change any other files.

*******
Testing
Expand All @@ -80,11 +71,16 @@ There are no automated tests for this project, however it is expected that any
development work is tested against a HA Server with both CalDav and Google Calendar
attached, this ensures no adverse impact is added with the feature or bugfix.

To create the card run the command ``yarn run build`` this output into the ``dist`` folder,
this can then be uploaded to HA for testing.

**********
Versioning
**********

This project follows `Semantic Versioning <http://semver.org>`_
You dont need to worry about versioning, the release process takes care of that for you!

But in case you are curious this project follows `Semantic Versioning <http://semver.org>`_

**MAJOR.MINOR.PATCH**

Expand All @@ -103,23 +99,35 @@ All changes are tracked in the `release notes <https://github.com/totaldebug/ato
Commit Changes
**************

Once you are happy with the changes, these can be committed:
Once you are happy with the changes, these can be committed (I recommend using commitizen):


.. code-block:: bash
git add .
git cz
Then follow the prompts and select the relevant options. If this resolves a specific issue, be sure to enter
the issue number when prompted.


.. code-block:: bash
git add .
git commit -v -m "feat: 100 Added new feature"
git commit -v -m "feat: Added new feature #100"
.. note::

Commit messages should follow `conventional commits <https://www.conventionalcommits.org/en/v1.0.0/>`_
Commit messages MUST follow `conventional commits <https://www.conventionalcommits.org/en/v1.0.0/>`_
this ensures clear commit messages within the repository. Without this your change will be rejected as it is required for release.

Breaking changes are detected with ``!`` e.g. ``feat!: my breaking change``


*******************
Submit Pull Request
*******************

Once development & testing are completed a pull request can be submitted for
the change that is required, ensure that all tests are passing and once they
are a member of the team will review the request, test and merge if appropriate
Once development & testing are completed a pull request can be created to the beta branch.

A member of the team will review the request, test and merge if appropriate.
5 changes: 0 additions & 5 deletions docs/overview/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,6 @@
FAQ
***

How come Calendar View doesnt show all my items?
################################################

By default only 5 events will be pulled from Google Calendar, to change this you need to follow the instructions [here](/atomic-calendar-revive/quickstart#show-more-than-5-events)

No card type configured error
#############################

Expand Down
24 changes: 0 additions & 24 deletions docs/overview/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,30 +53,6 @@ Manual

If you are upgrading, try to reload your browser cache by pressing ctrl-shift-r or shift-F5.

.. note::

If you want to use ``Calendar mode`` follow the guide :ref:`more-than-5`, by default HA only gets 5 events from Google Calendar.


.. _more-than-5:

Show more than 5 events
#######################

In order to increase the amount of events that are shown you have to add `max_results` setting to `google_calendars.yaml` file

For calendar mode we recommend that this is set to at least 42

.. code-block:: yaml
:linenos:
- cal_id: [email protected]
entities:
- device_id: calendar_id
name: Calendar_name
max_results: 42
Configuration
#############

Expand Down
3 changes: 1 addition & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "atomic-calendar-revive",
"version": "8.0.0",
"version": "9.0.0-beta.2",
"description": "Calendar Card for Home Assistant",
"main": "atomic-calendar-revive.js",
"scripts": {
Expand Down Expand Up @@ -110,7 +110,6 @@
"npmPublish": false
}
],

[
"@semantic-release/exec",
{
Expand Down
7 changes: 0 additions & 7 deletions src/defaults.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,6 @@ export default {
// color and font settings
nameColor: 'var(--primary-text-color)', // Card Name color

dateColor: 'var(--primary-text-color)', // Date text color (left side)
dateSize: 90, //Date text size (percent of standard text)

descColor: 'var(--primary-text-color)', // Description text color (left side)
descSize: 80, //Description text size (percent of standard text)

Expand All @@ -49,13 +46,10 @@ export default {
showNoEventDays: false,


timeColor: 'var(--primary-color)', // Time text color (center bottom)
timeSize: 90, //Time text size
showHours: true, //shows the bottom line (time, duration of event)
showRelativeTime: true,

eventTitleColor: 'var(--primary-text-color)', //Event title settings (center top), if no custom color set
eventTitleSize: 100,

locationIconColor: 'rgb(--primary-text-color)', //Location link settings (right side)
locationTextSize: 90,
Expand All @@ -67,7 +61,6 @@ export default {
finishedEventFilter: 'grayscale(80%)', // css filter

// days separating
dayWrapperLineColor: 'var(--primary-text-color)', // days separating line color
eventBarColor: 'var(--primary-color)',

eventCalNameColor: 'var(--primary-text-color)',
Expand Down
10 changes: 5 additions & 5 deletions src/editor.ts
Original file line number Diff line number Diff line change
Expand Up @@ -383,11 +383,6 @@ export class AtomicCalendarReviveEditor extends ScopedRegistryHost(LitElement) i
name: 'compactMode',
label: localize('main.fields.compactMode'),
},
{
type: 'switch',
name: 'hoursOnSameLine',
label: localize('main.fields.hoursOnSameLine'),
},
{
type: 'switch',
name: 'showAllDayEvents',
Expand Down Expand Up @@ -539,6 +534,11 @@ export class AtomicCalendarReviveEditor extends ScopedRegistryHost(LitElement) i
label: localize('event.fields.showAllDayHours'),
default: defaultConfig.showAllDayHours,
},
{
type: 'switch',
name: 'hoursOnSameLine',
label: localize('event.fields.hoursOnSameLine'),
}
],
},
calendar: {
Expand Down
Loading

0 comments on commit b6be297

Please sign in to comment.