Skip to content

feat: Add dev container for library development - #263

Merged
milesburton merged 2 commits into
masterfrom
add-dev-container
Jan 9, 2025
Merged

milesburton merged 2 commits into
masterfrom
add-dev-container

Conversation

@milesburton

Copy link
Copy Markdown
Owner

feat(dev): add development container support

✨ Adds development container configuration for consistent library development environment.

This PR introduces the following changes:

feat(dev): add VSCode dev container configuration

  • Add devcontainer.json with Arduino development extensions
  • Configure container for Arduino CLI and required dependencies
  • Set up automated library installation and updates

feat(build): add build automation scripts

  • Add build.sh script for automated compilation and testing
  • Configure aliases for common development tasks
  • Support separate build and test operations

docs(readme): improve documentation and setup instructions

  • Reorganise README.md with clearer structure
  • Add emojis for better visual organization
  • Include Arduino IDE installation instructions
  • Document development container usage
  • Add basic usage examples

chore(deps): streamline library dependencies

  • Remove unnecessary library installations
  • Focus on core OneWire dependency
  • Configure proper ESP8266/ESP32 core installations

Miles Burton and others added 2 commits January 9, 2025 17:01
@milesburton milesburton self-assigned this Jan 9, 2025
@milesburton

Copy link
Copy Markdown
Owner Author

@RobTillaart This doesn't actually change the current 3.x library but instead adds a dev container so devs who want to contribute to the library can just load the entire thing up in a dev container. Not sure if you want to give it a quick sanity check, if not I'll just merge

@RobTillaart

Copy link
Copy Markdown
Contributor

Never worked with docker, so I let it pass for now.
(doing the dishes has now top prio :)

@milesburton

Copy link
Copy Markdown
Owner Author

It's very cool. Using a dev container you can spin up an entire environment in one click using infrastructure as code. For us that means we can define a operating system, say Ubuntu, the tooling we need, any alias' etc. That means you don't need to faff around messing around installing misc libraries on your bare metal hardware.

Check it out when you get a chance. it could be a brilliant addition to your arduino libraries and would enable collaboration to be so much smoother

@milesburton
milesburton merged commit 222ba3f into master Jan 9, 2025
@milesburton
milesburton deleted the add-dev-container branch January 9, 2025 18:14
@RobTillaart

Copy link
Copy Markdown
Contributor

I know it is cool stuff, it is on my todo list, but it never reaches the top (so far :)

@milesburton

Copy link
Copy Markdown
Owner Author

Let me know if you want to me to raise a PR to add these to your libraries. Shouldn't be too hard

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants