Skip to content

Commit

Permalink
fix(ci): verify docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
bdeneux committed Oct 19, 2022
1 parent 70bc47b commit 12eb19e
Show file tree
Hide file tree
Showing 7 changed files with 21 additions and 21 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -276,10 +276,10 @@ jobs:
docs
- name: Run step only when files change.
if: steps.verify-changed-docs-files.outputs.files_changed == 'true'
if: contains(steps.verify-changed-docs-files.outputs.changed_files, 'docs')
run: |
echo "❌ Documentation files has been updated."
echo " Changed files : ${{ steps.verify-changed-files.outputs.changed_files }}"
echo " Changed files : ${{ steps.verify-changed-docs-files.outputs.changed_files }}"
echo "Please generate docs using \`cargo make generate_docs\` then commit this new documentation."
exit 1
Expand Down
6 changes: 3 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@

* [InstantiateMsg](./cw-template-instantiatemsg.md "Instantiate messages")`undefined#/instantiate`

* [Untitled object in cw-template](./cw-template-executemsg-oneof-increment-properties-increment.md)`undefined#/execute/oneOf/0/properties/increment`
* [Reset](./cw-template-executemsg-oneof-reset.md "Reset counter to the specified value")`undefined#/execute/oneOf/1`

* [Untitled object in cw-template](./cw-template-executemsg-oneof-1.md)`undefined#/execute/oneOf/1`
* [Untitled object in cw-template](./cw-template-executemsg-oneof-increment-properties-increment.md)`undefined#/execute/oneOf/0/properties/increment`

* [Untitled object in cw-template](./cw-template-executemsg-oneof-1-properties-reset.md)`undefined#/execute/oneOf/1/properties/reset`
* [Untitled object in cw-template](./cw-template-executemsg-oneof-reset-properties-reset.md)`undefined#/execute/oneOf/1/properties/reset`

* [Untitled object in cw-template](./cw-template-querymsg-oneof-getcount-properties-get_count.md)`undefined#/query/oneOf/0/properties/get_count`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ undefined#/execute/oneOf/1/properties/reset

## reset Type

`object` ([Details](cw-template-executemsg-oneof-1-properties-reset.md))
`object` ([Details](cw-template-executemsg-oneof-reset-properties-reset.md))

# reset Properties

| Property | Type | Required | Nullable | Defined by |
| :-------------- | :-------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------ |
| [count](#count) | `integer` | Required | cannot be null | [cw-template](cw-template-executemsg-oneof-1-properties-reset-properties-count.md "undefined#/execute/oneOf/1/properties/reset/properties/count") |
| Property | Type | Required | Nullable | Defined by |
| :-------------- | :-------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------- |
| [count](#count) | `integer` | Required | cannot be null | [cw-template](cw-template-executemsg-oneof-reset-properties-reset-properties-count.md "undefined#/execute/oneOf/1/properties/reset/properties/count") |

## count

Expand All @@ -32,7 +32,7 @@ undefined#/execute/oneOf/1/properties/reset

* cannot be null

* defined in: [cw-template](cw-template-executemsg-oneof-1-properties-reset-properties-count.md "undefined#/execute/oneOf/1/properties/reset/properties/count")
* defined in: [cw-template](cw-template-executemsg-oneof-reset-properties-reset-properties-count.md "undefined#/execute/oneOf/1/properties/reset/properties/count")

### count Type

Expand Down
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
# Untitled object in cw-template Schema
# Reset Schema

```txt
undefined#/execute/oneOf/1
```


Reset counter to the specified value.

| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------- |
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | [cw-template.json\*](schema/cw-template.json "open original schema") |

## 1 Type

`object` ([Details](cw-template-executemsg-oneof-1.md))
`object` ([Reset](cw-template-executemsg-oneof-reset.md))

# 1 Properties

| Property | Type | Required | Nullable | Defined by |
| :-------------- | :------- | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------- |
| [reset](#reset) | `object` | Required | cannot be null | [cw-template](cw-template-executemsg-oneof-1-properties-reset.md "undefined#/execute/oneOf/1/properties/reset") |
| Property | Type | Required | Nullable | Defined by |
| :-------------- | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------ |
| [reset](#reset) | `object` | Required | cannot be null | [cw-template](cw-template-executemsg-oneof-reset-properties-reset.md "undefined#/execute/oneOf/1/properties/reset") |

## reset

Expand All @@ -28,12 +28,12 @@ undefined#/execute/oneOf/1

* is required

* Type: `object` ([Details](cw-template-executemsg-oneof-1-properties-reset.md))
* Type: `object` ([Details](cw-template-executemsg-oneof-reset-properties-reset.md))

* cannot be null

* defined in: [cw-template](cw-template-executemsg-oneof-1-properties-reset.md "undefined#/execute/oneOf/1/properties/reset")
* defined in: [cw-template](cw-template-executemsg-oneof-reset-properties-reset.md "undefined#/execute/oneOf/1/properties/reset")

### reset Type

`object` ([Details](cw-template-executemsg-oneof-1-properties-reset.md))
`object` ([Details](cw-template-executemsg-oneof-reset-properties-reset.md))
2 changes: 1 addition & 1 deletion docs/cw-template-executemsg.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ one (and only one) of

* [Increment](cw-template-executemsg-oneof-increment.md "check type definition")

* [Untitled object in cw-template](cw-template-executemsg-oneof-1.md "check type definition")
* [Reset](cw-template-executemsg-oneof-reset.md "check type definition")
2 changes: 1 addition & 1 deletion docs/schema/cw-template.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"contract_name":"cw-template","contract_version":"0.2.0","idl_version":"1.0.0","instantiate":{"$schema":"http://json-schema.org/draft-07/schema#","title":"InstantiateMsg","description":"Instantiate messages","type":"object","required":["count"],"properties":{"count":{"type":"integer","format":"int32"}},"additionalProperties":false},"execute":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ExecuteMsg","description":"Execute messages","oneOf":[{"title":"Increment","description":"Execute an increment message.","type":"object","required":["increment"],"properties":{"increment":{"type":"object","additionalProperties":false}},"additionalProperties":false},{"type":"object","required":["reset"],"properties":{"reset":{"type":"object","required":["count"],"properties":{"count":{"type":"integer","format":"int32"}},"additionalProperties":false}},"additionalProperties":false}]},"query":{"$schema":"http://json-schema.org/draft-07/schema#","title":"QueryMsg","description":"Query messages","oneOf":[{"title":"GetCount","description":"GetCount returns the current count as a json-encoded number","type":"object","required":["get_count"],"properties":{"get_count":{"type":"object","additionalProperties":false}},"additionalProperties":false}]},"migrate":null,"sudo":null,"responses":{"get_count":{"$schema":"http://json-schema.org/draft-07/schema#","title":"GetCountResponse","description":"We define a custom struct for each query response","type":"object","required":["count"],"properties":{"count":{"type":"integer","format":"int32"}},"additionalProperties":false}},"description":"# CW Template\n\nBase smart contract to start coding into the blockchain 🚀.\n\nThis contract has been created with the cosmwasm [cw-template](https://github.com/InterWasm/cw-template) following the [cosmwasm documentation](https://docs.cosmwasm.com/fr/tutorials/simple-option/setup#project-starter).","title":"cw-template"}
{"contract_name":"cw-template","contract_version":"0.2.0","idl_version":"1.0.0","instantiate":{"$schema":"http://json-schema.org/draft-07/schema#","title":"InstantiateMsg","description":"Instantiate messages","type":"object","required":["count"],"properties":{"count":{"type":"integer","format":"int32"}},"additionalProperties":false},"execute":{"$schema":"http://json-schema.org/draft-07/schema#","title":"ExecuteMsg","description":"Execute messages","oneOf":[{"title":"Increment","description":"Execute an increment message.","type":"object","required":["increment"],"properties":{"increment":{"type":"object","additionalProperties":false}},"additionalProperties":false},{"title":"Reset","description":"Reset counter to the specified value.","type":"object","required":["reset"],"properties":{"reset":{"type":"object","required":["count"],"properties":{"count":{"type":"integer","format":"int32"}},"additionalProperties":false}},"additionalProperties":false}]},"query":{"$schema":"http://json-schema.org/draft-07/schema#","title":"QueryMsg","description":"Query messages","oneOf":[{"title":"GetCount","description":"GetCount returns the current count as a json-encoded number","type":"object","required":["get_count"],"properties":{"get_count":{"type":"object","additionalProperties":false}},"additionalProperties":false}]},"migrate":null,"sudo":null,"responses":{"get_count":{"$schema":"http://json-schema.org/draft-07/schema#","title":"GetCountResponse","description":"We define a custom struct for each query response","type":"object","required":["count"],"properties":{"count":{"type":"integer","format":"int32"}},"additionalProperties":false}},"description":"# CW Template\n\nBase smart contract to start coding into the blockchain 🚀.\n\nThis contract has been created with the cosmwasm [cw-template](https://github.com/InterWasm/cw-template) following the [cosmwasm documentation](https://docs.cosmwasm.com/fr/tutorials/simple-option/setup#project-starter).","title":"cw-template"}

0 comments on commit 12eb19e

Please sign in to comment.