Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix docs checks #89

Merged
merged 2 commits into from
Sep 28, 2020
Merged

Fix docs checks #89

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a919864
docs: fix missing create device arg --userdata-file
displague Sep 28, 2020
00e8cfc
tests: fix check for missing docs
displague Sep 28, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,4 @@ jobs:
env:
PACKET_TOKEN: bogus
- name: Detect Uncommitted Docs
run: git diff docs
run: git diff --exit-code docs
4 changes: 2 additions & 2 deletions cmd/create_device.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,8 +131,8 @@ func init() {

createDeviceCmd.Flags().StringVarP(&storage, "storage", "s", "", "UUID of the storage")
createDeviceCmd.Flags().StringVarP(&ipxescripturl, "ipxe-script-url", "i", "", "URL to the iPXE script")
createDeviceCmd.Flags().StringVarP(&userdata, "userdata", "u", "", "User data")
createDeviceCmd.Flags().StringVarP(&userdataFile, "userdata-file", "", "", "Filename to read Userdata from")
createDeviceCmd.Flags().StringVarP(&userdata, "userdata", "u", "", "Userdata for device initialization (can not be used with --userdata-file)")
createDeviceCmd.Flags().StringVarP(&userdataFile, "userdata-file", "", "", "Path to a userdata file for device initialization (can not be used with --userdata)")
createDeviceCmd.Flags().StringVarP(&customdata, "customdata", "c", "", "Custom data")
createDeviceCmd.Flags().StringSliceVarP(&tags, "tags", "t", []string{}, `Tags for the device: --tags="tag1,tag2"`)
createDeviceCmd.Flags().IntVarP(&publicIPv4SubnetSize, "public-ipv4-subnet-size", "v", 0, "Size of the public IPv4 subnet")
Expand Down
3 changes: 2 additions & 1 deletion docs/packet_device_create.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@ packet device create [flags]
-s, --storage string UUID of the storage
-t, --tags strings Tags for the device: --tags="tag1,tag2"
-T, --termination-time string Device termination time: --termination-time="15:04:05"
-u, --userdata string User data
-u, --userdata string Userdata for device initialization (can not be used with --userdata-file)
--userdata-file string Path to a userdata file for device initialization (can not be used with --userdata)
```

### Options inherited from parent commands
Expand Down