monday_ruby 1.2.0 → 1.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/lib/monday/version.rb +1 -1
- metadata +3 -79
- data/.env +0 -1
- data/.rspec +0 -2
- data/.rubocop.yml +0 -41
- data/.simplecov +0 -4
- data/.vscode/settings.json +0 -4
- data/CODE_OF_CONDUCT.md +0 -84
- data/CONTRIBUTING.md +0 -190
- data/Rakefile +0 -11
- data/docs/.vitepress/config.mjs +0 -255
- data/docs/.vitepress/theme/index.js +0 -4
- data/docs/.vitepress/theme/style.css +0 -43
- data/docs/README.md +0 -80
- data/docs/explanation/architecture.md +0 -507
- data/docs/explanation/best-practices/errors.md +0 -478
- data/docs/explanation/best-practices/performance.md +0 -1084
- data/docs/explanation/best-practices/rate-limiting.md +0 -630
- data/docs/explanation/best-practices/testing.md +0 -820
- data/docs/explanation/column-values.md +0 -857
- data/docs/explanation/design.md +0 -795
- data/docs/explanation/graphql.md +0 -356
- data/docs/explanation/migration/v1.md +0 -808
- data/docs/explanation/pagination.md +0 -447
- data/docs/guides/advanced/batch.md +0 -1274
- data/docs/guides/advanced/complex-queries.md +0 -1114
- data/docs/guides/advanced/errors.md +0 -818
- data/docs/guides/advanced/pagination.md +0 -934
- data/docs/guides/advanced/rate-limiting.md +0 -981
- data/docs/guides/authentication.md +0 -286
- data/docs/guides/boards/create.md +0 -386
- data/docs/guides/boards/delete.md +0 -405
- data/docs/guides/boards/duplicate.md +0 -511
- data/docs/guides/boards/query.md +0 -530
- data/docs/guides/boards/update.md +0 -453
- data/docs/guides/columns/create.md +0 -452
- data/docs/guides/columns/metadata.md +0 -492
- data/docs/guides/columns/query.md +0 -455
- data/docs/guides/columns/update-multiple.md +0 -459
- data/docs/guides/columns/update-values.md +0 -509
- data/docs/guides/files/add-to-column.md +0 -40
- data/docs/guides/files/add-to-update.md +0 -37
- data/docs/guides/files/clear-column.md +0 -33
- data/docs/guides/first-request.md +0 -285
- data/docs/guides/folders/manage.md +0 -750
- data/docs/guides/groups/items.md +0 -626
- data/docs/guides/groups/manage.md +0 -501
- data/docs/guides/installation.md +0 -169
- data/docs/guides/items/create.md +0 -493
- data/docs/guides/items/delete.md +0 -514
- data/docs/guides/items/query.md +0 -605
- data/docs/guides/items/subitems.md +0 -483
- data/docs/guides/items/update.md +0 -699
- data/docs/guides/updates/manage.md +0 -619
- data/docs/guides/use-cases/dashboard.md +0 -1421
- data/docs/guides/use-cases/import.md +0 -1962
- data/docs/guides/use-cases/task-management.md +0 -1381
- data/docs/guides/workspaces/manage.md +0 -502
- data/docs/index.md +0 -69
- data/docs/package-lock.json +0 -2468
- data/docs/package.json +0 -13
- data/docs/reference/client.md +0 -540
- data/docs/reference/configuration.md +0 -586
- data/docs/reference/errors.md +0 -693
- data/docs/reference/resources/account.md +0 -208
- data/docs/reference/resources/activity-log.md +0 -369
- data/docs/reference/resources/board-view.md +0 -359
- data/docs/reference/resources/board.md +0 -393
- data/docs/reference/resources/column.md +0 -543
- data/docs/reference/resources/file.md +0 -236
- data/docs/reference/resources/folder.md +0 -386
- data/docs/reference/resources/group.md +0 -507
- data/docs/reference/resources/item.md +0 -348
- data/docs/reference/resources/subitem.md +0 -267
- data/docs/reference/resources/update.md +0 -259
- data/docs/reference/resources/workspace.md +0 -213
- data/docs/reference/response.md +0 -560
- data/docs/tutorial/first-integration.md +0 -713
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 3837300eeee4b5c5fc64a1c69eccc897cbbf57dc05acfaba3163bd67d1d1beb8
|
|
4
|
+
data.tar.gz: c0164784b3ec5b9780e735082e47f5f6381d8b115a11310addb707c046b84f0d
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: fb6897aa4cb9810db87e09f0d70a9614d01cc5685c1cd5992780c0838e6f5a84444d430ad20454dd1a144d897a037fb84dc40b2cc9fb88289222f3a5cad7860a
|
|
7
|
+
data.tar.gz: 5642bf287741d7d3464142e5a4c78ce8d9da29be8ded5f9849820e6b6112258e8f3a8273618388c656649b89ba9d426106b91595e9f188c8ea1fb9d89c54f895
|
data/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,13 @@
|
|
|
1
|
+
## v1.2.1 (January 23, 2026)
|
|
2
|
+
|
|
3
|
+
### Fixed
|
|
4
|
+
|
|
5
|
+
- Fixed issue where any string containing a dollar sign was incorrectly treated as a GraphQL variable.
|
|
6
|
+
|
|
7
|
+
### Changed
|
|
8
|
+
|
|
9
|
+
- Updated `base64` dependency requirement from `~> 0.2.0` to `>= 0.2, < 0.4` for broader compatibility.
|
|
10
|
+
|
|
1
11
|
## v1.2.0 (November 18, 2025)
|
|
2
12
|
|
|
3
13
|
#### Added
|
data/lib/monday/version.rb
CHANGED
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: monday_ruby
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.2.
|
|
4
|
+
version: 1.2.1
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Sanif Himani
|
|
@@ -38,7 +38,7 @@ dependencies:
|
|
|
38
38
|
- - "~>"
|
|
39
39
|
- !ruby/object:Gem::Version
|
|
40
40
|
version: '2.4'
|
|
41
|
-
description: A
|
|
41
|
+
description: A Ruby gem for interacting with monday.com's API
|
|
42
42
|
email:
|
|
43
43
|
- sanifhimani92@gmail.com
|
|
44
44
|
- weshays@gmail.com
|
|
@@ -46,85 +46,9 @@ executables: []
|
|
|
46
46
|
extensions: []
|
|
47
47
|
extra_rdoc_files: []
|
|
48
48
|
files:
|
|
49
|
-
- ".env"
|
|
50
|
-
- ".rspec"
|
|
51
|
-
- ".rubocop.yml"
|
|
52
|
-
- ".simplecov"
|
|
53
|
-
- ".vscode/settings.json"
|
|
54
49
|
- CHANGELOG.md
|
|
55
|
-
- CODE_OF_CONDUCT.md
|
|
56
|
-
- CONTRIBUTING.md
|
|
57
50
|
- LICENSE
|
|
58
51
|
- README.md
|
|
59
|
-
- Rakefile
|
|
60
|
-
- docs/.vitepress/config.mjs
|
|
61
|
-
- docs/.vitepress/theme/index.js
|
|
62
|
-
- docs/.vitepress/theme/style.css
|
|
63
|
-
- docs/README.md
|
|
64
|
-
- docs/explanation/architecture.md
|
|
65
|
-
- docs/explanation/best-practices/errors.md
|
|
66
|
-
- docs/explanation/best-practices/performance.md
|
|
67
|
-
- docs/explanation/best-practices/rate-limiting.md
|
|
68
|
-
- docs/explanation/best-practices/testing.md
|
|
69
|
-
- docs/explanation/column-values.md
|
|
70
|
-
- docs/explanation/design.md
|
|
71
|
-
- docs/explanation/graphql.md
|
|
72
|
-
- docs/explanation/migration/v1.md
|
|
73
|
-
- docs/explanation/pagination.md
|
|
74
|
-
- docs/guides/advanced/batch.md
|
|
75
|
-
- docs/guides/advanced/complex-queries.md
|
|
76
|
-
- docs/guides/advanced/errors.md
|
|
77
|
-
- docs/guides/advanced/pagination.md
|
|
78
|
-
- docs/guides/advanced/rate-limiting.md
|
|
79
|
-
- docs/guides/authentication.md
|
|
80
|
-
- docs/guides/boards/create.md
|
|
81
|
-
- docs/guides/boards/delete.md
|
|
82
|
-
- docs/guides/boards/duplicate.md
|
|
83
|
-
- docs/guides/boards/query.md
|
|
84
|
-
- docs/guides/boards/update.md
|
|
85
|
-
- docs/guides/columns/create.md
|
|
86
|
-
- docs/guides/columns/metadata.md
|
|
87
|
-
- docs/guides/columns/query.md
|
|
88
|
-
- docs/guides/columns/update-multiple.md
|
|
89
|
-
- docs/guides/columns/update-values.md
|
|
90
|
-
- docs/guides/files/add-to-column.md
|
|
91
|
-
- docs/guides/files/add-to-update.md
|
|
92
|
-
- docs/guides/files/clear-column.md
|
|
93
|
-
- docs/guides/first-request.md
|
|
94
|
-
- docs/guides/folders/manage.md
|
|
95
|
-
- docs/guides/groups/items.md
|
|
96
|
-
- docs/guides/groups/manage.md
|
|
97
|
-
- docs/guides/installation.md
|
|
98
|
-
- docs/guides/items/create.md
|
|
99
|
-
- docs/guides/items/delete.md
|
|
100
|
-
- docs/guides/items/query.md
|
|
101
|
-
- docs/guides/items/subitems.md
|
|
102
|
-
- docs/guides/items/update.md
|
|
103
|
-
- docs/guides/updates/manage.md
|
|
104
|
-
- docs/guides/use-cases/dashboard.md
|
|
105
|
-
- docs/guides/use-cases/import.md
|
|
106
|
-
- docs/guides/use-cases/task-management.md
|
|
107
|
-
- docs/guides/workspaces/manage.md
|
|
108
|
-
- docs/index.md
|
|
109
|
-
- docs/package-lock.json
|
|
110
|
-
- docs/package.json
|
|
111
|
-
- docs/reference/client.md
|
|
112
|
-
- docs/reference/configuration.md
|
|
113
|
-
- docs/reference/errors.md
|
|
114
|
-
- docs/reference/resources/account.md
|
|
115
|
-
- docs/reference/resources/activity-log.md
|
|
116
|
-
- docs/reference/resources/board-view.md
|
|
117
|
-
- docs/reference/resources/board.md
|
|
118
|
-
- docs/reference/resources/column.md
|
|
119
|
-
- docs/reference/resources/file.md
|
|
120
|
-
- docs/reference/resources/folder.md
|
|
121
|
-
- docs/reference/resources/group.md
|
|
122
|
-
- docs/reference/resources/item.md
|
|
123
|
-
- docs/reference/resources/subitem.md
|
|
124
|
-
- docs/reference/resources/update.md
|
|
125
|
-
- docs/reference/resources/workspace.md
|
|
126
|
-
- docs/reference/response.md
|
|
127
|
-
- docs/tutorial/first-integration.md
|
|
128
52
|
- lib/monday/client.rb
|
|
129
53
|
- lib/monday/configuration.rb
|
|
130
54
|
- lib/monday/deprecation.rb
|
|
@@ -154,7 +78,7 @@ licenses:
|
|
|
154
78
|
metadata:
|
|
155
79
|
homepage_uri: https://github.com/sanifhimani/monday_ruby
|
|
156
80
|
documentation_uri: https://sanifhimani.github.io/monday_ruby/
|
|
157
|
-
changelog_uri: https://github.com/sanifhimani/monday_ruby/blob/v1.2.
|
|
81
|
+
changelog_uri: https://github.com/sanifhimani/monday_ruby/blob/v1.2.1/CHANGELOG.md
|
|
158
82
|
rubygems_mfa_required: 'true'
|
|
159
83
|
rdoc_options: []
|
|
160
84
|
require_paths:
|
data/.rspec
DELETED
data/.rubocop.yml
DELETED
|
@@ -1,41 +0,0 @@
|
|
|
1
|
-
plugins:
|
|
2
|
-
- rubocop-rake
|
|
3
|
-
- rubocop-rspec
|
|
4
|
-
|
|
5
|
-
AllCops:
|
|
6
|
-
TargetRubyVersion: 2.7
|
|
7
|
-
NewCops: enable
|
|
8
|
-
SuggestExtensions: false
|
|
9
|
-
Exclude:
|
|
10
|
-
- "spec/support/**/*.rb"
|
|
11
|
-
- "vendor/**/*"
|
|
12
|
-
|
|
13
|
-
Style/StringLiterals:
|
|
14
|
-
Enabled: true
|
|
15
|
-
EnforcedStyle: double_quotes
|
|
16
|
-
|
|
17
|
-
Style/StringLiteralsInInterpolation:
|
|
18
|
-
Enabled: true
|
|
19
|
-
EnforcedStyle: double_quotes
|
|
20
|
-
|
|
21
|
-
Layout/LineLength:
|
|
22
|
-
Max: 120
|
|
23
|
-
|
|
24
|
-
Metrics/BlockLength:
|
|
25
|
-
Exclude:
|
|
26
|
-
- "spec/**/*_spec.rb"
|
|
27
|
-
|
|
28
|
-
Metrics/MethodLength:
|
|
29
|
-
Exclude:
|
|
30
|
-
- "lib/monday/configuration.rb"
|
|
31
|
-
- "lib/monday/util.rb"
|
|
32
|
-
|
|
33
|
-
Metrics/ParameterLists:
|
|
34
|
-
Exclude:
|
|
35
|
-
- "lib/monday/resources/group.rb"
|
|
36
|
-
|
|
37
|
-
RSpec/NestedGroups:
|
|
38
|
-
Max: 5
|
|
39
|
-
|
|
40
|
-
RSpec/MultipleMemoizedHelpers:
|
|
41
|
-
Max: 11
|
data/.simplecov
DELETED
data/.vscode/settings.json
DELETED
data/CODE_OF_CONDUCT.md
DELETED
|
@@ -1,84 +0,0 @@
|
|
|
1
|
-
# Contributor Covenant Code of Conduct
|
|
2
|
-
|
|
3
|
-
## Our Pledge
|
|
4
|
-
|
|
5
|
-
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
|
|
6
|
-
|
|
7
|
-
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
|
|
8
|
-
|
|
9
|
-
## Our Standards
|
|
10
|
-
|
|
11
|
-
Examples of behavior that contributes to a positive environment for our community include:
|
|
12
|
-
|
|
13
|
-
* Demonstrating empathy and kindness toward other people
|
|
14
|
-
* Being respectful of differing opinions, viewpoints, and experiences
|
|
15
|
-
* Giving and gracefully accepting constructive feedback
|
|
16
|
-
* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
|
|
17
|
-
* Focusing on what is best not just for us as individuals, but for the overall community
|
|
18
|
-
|
|
19
|
-
Examples of unacceptable behavior include:
|
|
20
|
-
|
|
21
|
-
* The use of sexualized language or imagery, and sexual attention or
|
|
22
|
-
advances of any kind
|
|
23
|
-
* Trolling, insulting or derogatory comments, and personal or political attacks
|
|
24
|
-
* Public or private harassment
|
|
25
|
-
* Publishing others' private information, such as a physical or email
|
|
26
|
-
address, without their explicit permission
|
|
27
|
-
* Other conduct which could reasonably be considered inappropriate in a
|
|
28
|
-
professional setting
|
|
29
|
-
|
|
30
|
-
## Enforcement Responsibilities
|
|
31
|
-
|
|
32
|
-
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
|
|
33
|
-
|
|
34
|
-
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
|
|
35
|
-
|
|
36
|
-
## Scope
|
|
37
|
-
|
|
38
|
-
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
|
|
39
|
-
|
|
40
|
-
## Enforcement
|
|
41
|
-
|
|
42
|
-
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at sanifhimani92@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
|
|
43
|
-
|
|
44
|
-
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
|
|
45
|
-
|
|
46
|
-
## Enforcement Guidelines
|
|
47
|
-
|
|
48
|
-
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
|
|
49
|
-
|
|
50
|
-
### 1. Correction
|
|
51
|
-
|
|
52
|
-
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
|
|
53
|
-
|
|
54
|
-
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
|
|
55
|
-
|
|
56
|
-
### 2. Warning
|
|
57
|
-
|
|
58
|
-
**Community Impact**: A violation through a single incident or series of actions.
|
|
59
|
-
|
|
60
|
-
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
|
|
61
|
-
|
|
62
|
-
### 3. Temporary Ban
|
|
63
|
-
|
|
64
|
-
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
|
|
65
|
-
|
|
66
|
-
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
|
|
67
|
-
|
|
68
|
-
### 4. Permanent Ban
|
|
69
|
-
|
|
70
|
-
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
|
|
71
|
-
|
|
72
|
-
**Consequence**: A permanent ban from any sort of public interaction within the community.
|
|
73
|
-
|
|
74
|
-
## Attribution
|
|
75
|
-
|
|
76
|
-
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
|
|
77
|
-
available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
|
|
78
|
-
|
|
79
|
-
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
|
|
80
|
-
|
|
81
|
-
[homepage]: https://www.contributor-covenant.org
|
|
82
|
-
|
|
83
|
-
For answers to common questions about this code of conduct, see the FAQ at
|
|
84
|
-
https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
|
data/CONTRIBUTING.md
DELETED
|
@@ -1,190 +0,0 @@
|
|
|
1
|
-
# Contributing
|
|
2
|
-
|
|
3
|
-
Thanks for taking the time to contribute!
|
|
4
|
-
|
|
5
|
-
The following is a set of guidelines for contributing to `monday_ruby`. These are mostly guidelines, not rules. Use your best judgment, and feel to propose changes to this document in a pull request.
|
|
6
|
-
|
|
7
|
-
## Your first code contribution
|
|
8
|
-
|
|
9
|
-
Unsure where to begin contributing? You can start by looking through `good first issue` and `help wanted` issues.
|
|
10
|
-
|
|
11
|
-
### Pull request
|
|
12
|
-
|
|
13
|
-
Please follow these steps to have your contribution considered:
|
|
14
|
-
|
|
15
|
-
1. Follow the [pull request template](PULL_REQUEST_TEMPLATE.md).
|
|
16
|
-
2. Follow the [commit guidelines](#commit-message-guidelines).
|
|
17
|
-
3. After you submit your pull request, verify that all the status checks are passing.
|
|
18
|
-
|
|
19
|
-
## Testing Guidelines
|
|
20
|
-
|
|
21
|
-
This project uses [VCR](https://github.com/vcr/vcr) to record HTTP interactions for tests. This means you **do not need a Monday.com API token** to run most tests or contribute to the project.
|
|
22
|
-
|
|
23
|
-
### Running Tests
|
|
24
|
-
|
|
25
|
-
To run the test suite:
|
|
26
|
-
|
|
27
|
-
```bash
|
|
28
|
-
bundle exec rake spec
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
All tests will use pre-recorded VCR cassettes stored in `spec/fixtures/vcr_cassettes/`.
|
|
32
|
-
|
|
33
|
-
### Working with VCR Cassettes
|
|
34
|
-
|
|
35
|
-
**For most contributions, you won't need to modify VCR cassettes.** The existing cassettes cover the current API functionality.
|
|
36
|
-
|
|
37
|
-
#### When You Need to Record New Cassettes
|
|
38
|
-
|
|
39
|
-
You only need to record new VCR cassettes when:
|
|
40
|
-
- Adding support for a **new API endpoint** that doesn't have existing test coverage
|
|
41
|
-
- Modifying an existing API call that changes the request/response structure
|
|
42
|
-
|
|
43
|
-
To record new cassettes:
|
|
44
|
-
|
|
45
|
-
1. Set your Monday.com API token as an environment variable:
|
|
46
|
-
```bash
|
|
47
|
-
export MONDAY_TOKEN="your_token_here"
|
|
48
|
-
```
|
|
49
|
-
|
|
50
|
-
2. Delete the old cassette file (if updating an existing test):
|
|
51
|
-
```bash
|
|
52
|
-
rm spec/fixtures/vcr_cassettes/your_cassette_name.yml
|
|
53
|
-
```
|
|
54
|
-
|
|
55
|
-
3. Run the specific test to generate a new cassette:
|
|
56
|
-
```bash
|
|
57
|
-
bundle exec rspec spec/path/to/your_spec.rb
|
|
58
|
-
```
|
|
59
|
-
|
|
60
|
-
4. **Important:** Before committing, verify the cassette doesn't contain sensitive data:
|
|
61
|
-
- VCR automatically filters the `Authorization` header
|
|
62
|
-
- Check for any other sensitive information in the cassette file
|
|
63
|
-
- Cassettes are committed to the repository
|
|
64
|
-
|
|
65
|
-
#### Testing New Features Without API Access
|
|
66
|
-
|
|
67
|
-
If you're adding a new feature but don't have API access to record cassettes:
|
|
68
|
-
1. Write your implementation and tests
|
|
69
|
-
2. Create a pull request noting that cassettes need to be recorded
|
|
70
|
-
3. A maintainer with API access will record the cassettes for you
|
|
71
|
-
|
|
72
|
-
### Code Quality
|
|
73
|
-
|
|
74
|
-
Run RuboCop to ensure code style compliance:
|
|
75
|
-
|
|
76
|
-
```bash
|
|
77
|
-
bundle exec rake rubocop
|
|
78
|
-
```
|
|
79
|
-
|
|
80
|
-
## Documentation
|
|
81
|
-
|
|
82
|
-
The project uses [VitePress](https://vitepress.dev/) to generate documentation from Markdown files. The documentation site is hosted at [https://sanifhimani.github.io/monday_ruby/](https://sanifhimani.github.io/monday_ruby/).
|
|
83
|
-
|
|
84
|
-
### When to Update Documentation
|
|
85
|
-
|
|
86
|
-
Update documentation when you:
|
|
87
|
-
- Add a new resource or method to the public API
|
|
88
|
-
- Change the behavior of existing methods
|
|
89
|
-
- Add new features or configuration options
|
|
90
|
-
- Fix bugs that affect documented behavior
|
|
91
|
-
|
|
92
|
-
### Documentation Structure
|
|
93
|
-
|
|
94
|
-
Documentation follows the [Diataxis framework](https://diataxis.fr):
|
|
95
|
-
|
|
96
|
-
- **Tutorial** (`docs/tutorial/`) - Learning-oriented, gets users started
|
|
97
|
-
- **How-to Guides** (`docs/guides/`) - Task-oriented, solves specific problems
|
|
98
|
-
- **Reference** (`docs/reference/`) - Information-oriented, describes the API
|
|
99
|
-
- **Explanation** (`docs/explanation/`) - Understanding-oriented, explains concepts
|
|
100
|
-
|
|
101
|
-
### Adding/Updating Documentation
|
|
102
|
-
|
|
103
|
-
Documentation files are located in the `docs/` directory:
|
|
104
|
-
|
|
105
|
-
```
|
|
106
|
-
docs/
|
|
107
|
-
├── .vitepress/
|
|
108
|
-
│ └── config.mjs # Navigation and site configuration
|
|
109
|
-
├── guides/ # How-to guides
|
|
110
|
-
│ ├── boards/
|
|
111
|
-
│ ├── items/
|
|
112
|
-
│ ├── columns/
|
|
113
|
-
│ └── advanced/
|
|
114
|
-
├── reference/ # API reference
|
|
115
|
-
│ ├── resources/
|
|
116
|
-
│ └── client.md
|
|
117
|
-
├── explanation/ # Conceptual documentation
|
|
118
|
-
└── tutorial/ # Getting started tutorial
|
|
119
|
-
```
|
|
120
|
-
|
|
121
|
-
#### Steps to Update Documentation:
|
|
122
|
-
|
|
123
|
-
1. **Find or create the appropriate file** based on what you're documenting
|
|
124
|
-
2. **Follow the existing format** - look at similar documentation files for examples
|
|
125
|
-
3. **Test your code examples** - all examples should be runnable and accurate
|
|
126
|
-
4. **Update navigation** if adding new pages - edit `docs/.vitepress/config.mjs`
|
|
127
|
-
5. **Build locally** to preview changes:
|
|
128
|
-
|
|
129
|
-
```bash
|
|
130
|
-
cd docs
|
|
131
|
-
npm install # First time only
|
|
132
|
-
npm run dev # Start local dev server
|
|
133
|
-
```
|
|
134
|
-
|
|
135
|
-
Visit `http://localhost:5173/monday_ruby/` to preview your changes.
|
|
136
|
-
|
|
137
|
-
6. **Check for broken links** before submitting:
|
|
138
|
-
|
|
139
|
-
```bash
|
|
140
|
-
cd docs
|
|
141
|
-
npm run build # Build will fail if there are dead links
|
|
142
|
-
```
|
|
143
|
-
|
|
144
|
-
#### Documentation Guidelines:
|
|
145
|
-
|
|
146
|
-
- **Code examples must be accurate** - verify against VCR test fixtures or real API
|
|
147
|
-
- **Include practical examples** - show real-world usage, not just syntax
|
|
148
|
-
- **Be consistent** - follow the style and tone of existing documentation
|
|
149
|
-
- **No emojis** - maintain professional tone in documentation
|
|
150
|
-
- **Link related pages** - help users discover relevant documentation
|
|
151
|
-
- **Keep examples self-contained** - users should be able to copy-paste and run
|
|
152
|
-
|
|
153
|
-
#### Example Documentation Pattern:
|
|
154
|
-
|
|
155
|
-
```markdown
|
|
156
|
-
# Resource Name
|
|
157
|
-
|
|
158
|
-
Brief description of what this resource does.
|
|
159
|
-
|
|
160
|
-
## Methods
|
|
161
|
-
|
|
162
|
-
### method_name
|
|
163
|
-
|
|
164
|
-
Description of what the method does.
|
|
165
|
-
|
|
166
|
-
\`\`\`ruby
|
|
167
|
-
# Example code that actually works
|
|
168
|
-
client = Monday::Client.new(token: ENV["MONDAY_TOKEN"])
|
|
169
|
-
response = client.resource.method_name(args: {})
|
|
170
|
-
\`\`\`
|
|
171
|
-
|
|
172
|
-
**Parameters:**
|
|
173
|
-
- List parameters and their types
|
|
174
|
-
|
|
175
|
-
**Returns:** Description of return value
|
|
176
|
-
|
|
177
|
-
**See:** Link to monday.com API docs
|
|
178
|
-
```
|
|
179
|
-
|
|
180
|
-
### Deploying Documentation
|
|
181
|
-
|
|
182
|
-
Documentation is automatically deployed via GitHub Actions when changes are merged to the `main` branch. You don't need to manually deploy.
|
|
183
|
-
|
|
184
|
-
## Commit message guidelines
|
|
185
|
-
|
|
186
|
-
* Use present tense ("Add feature" not "Added feature")
|
|
187
|
-
* Use the imperative mood ("Move file to..." not "Moves file to...")
|
|
188
|
-
* Limit the first line to 70 characters or less.
|
|
189
|
-
* Reference issues and pull requests after the first line.
|
|
190
|
-
* Try to follow [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/)
|