-
Notifications
You must be signed in to change notification settings - Fork 15
Open Hour Agendas and Notes: 2020 04
Cassandra edited this page Jun 3, 2020
·
1 revision
- 3000.1 status
- PR Backlog Updates
- Testing Clinic
- Community Questions
Cassandra Faris
- Virtual meetup every Wednesday starting April 15, times and topics vary to allow more people to participate. If you're interested in speaking or have topic suggestions, contact Cassandra.
- Twitch stream is active and streaming regularly. Follow saltstackinc on Twitch.
Megan Wilhite
- 3000.1 released April 1. It fixed several issues, updated build scripts, and fixed several tests.
- Release Notes: https://docs.saltstack.com/en/latest/topics/releases/3000.1.html.
- Changelog: https://github.com/saltstack/salt/blob/master/CHANGELOG.md.
Gareth Greenaway & Sage Robins
- 494 outstanding items (down from ~900), ~200 can be automated.
- PRs Assigned Dashboard has been created to help us prioritize
Gareth Greenaway & Wayne Werner
- Unit Test: Testing a specific chunk of code. Not necessary that it mocks out different bits & pieces of external code, but is possible. In the current code base, many unit tests do mock things out.
- Drawbacks: May not be testing the code completely, danger of mocking too much, can freeze implementation if the test mocks too many things.
- Benefits: Fast, everything is in memory, specific telling exactly what the problem is, The majority of our tests.
- Functional Test: Testing anything that's talking to a database, the disc, an underlying file system, or an actual command.
- Drawbacks: Slower because disc and network access is slow, not absolutely complete.
- Benefits: Exposes if something on the underlying system changed.
- Integration Test: Use case - You have a Master and minion/set of minons or salt SSH - have full environment set up and so you're doing the round trip communication.
- They should have a very specific purpose.
- Provides full confidence that we're releasing bug-free.
- When bugs are seen in the wild, we should write integration tests that capture that bug so we know we're not breaking that flow. Eventually, enough integration tests will exist that we will have bug-free code.
- Get started by referencing PRs Port to Master Project Board, go to filter and search by label: "Needs Testcase". These PRs are waiting on tests then can be ported to Master.
- We write tests because it helps us shift the best, most bug-free Salt that we can.
- Join Testing Working Group for more collaboration opportunities.
- Video walkthrough of Tests: https://www.youtube.com/watch?v=FKrmf7-qrfA.
- Community Updates
- Stale bot changes
- IRC Bridge to Slack
- Highlight: Documentation Working Group
- Community Questions & Open Discussion
Cassandra Faris
- Virtual meetups, SaltStackInc Twitch, and The Hacks podcast are in a regular cadence
- POP Q&A to be scheduled for an upcoming Open Hour
Wayne Werner, Sage Robins
- Stalebot to be disabled on April 10, 2020
- IRC Bridge to Slack needs updated, issue has been created
Alyssa Rock, Alan Culger
-
Goals
- Help with documentation for onboarding & getting things done
- Create a consistent set of tools
-
Initiatives and Planned Projects
- Will be upgrading Sphinx. Changes shouldn't be noticeable right away, until UI starts to change
- Standardized documentation format will be put into place. We want to make sure that code is readable in docs. This may require a SEP.
- Recognize that community has wanted something easy for new beginners to start on and also that advanced users want more
- Migrating from Github to Gitlab, using CICD pipeline and updating some things from the back end
- Using an OS theme provided by the Read the Docs Group, gives functionality including tabbed and expandable content
- More popular modules will be fleshed out more quickly, then expand to the less popular modules. Will probably focus on most core modules first.
- If someone is looking for support on a documentation issue, submit to Open Salt issues for consideration
- Some of the work overlaps with other groups (ex. Testing or Windows)
- Timelines depend, but doc set likely to be in the Fall depending on time & resource allocation/participants
-
Why to join?
- Newbie friendly - great place to start while contributing to Salt. You'll find things in doc that you think could be better and will be able to make those changes
- Can influence common questions to documents to minimize redundant work
- Documentation makes a difference - in 2017, GitHub's open source survey found that doc is important but overlooked. Affects 93% of respondents, but only 60% contribute to it. It's one of the best ways to contribute
- Community Updates
- Release Timeline & MVPs
- Towncrier & Changelog
- Bridge to IRC
- Open Discussion
Cassandra Faris
- First virtual meetup happened April 16 with Tyler Johnson speaking on Extending Grains With Pop. The talk will be repeated on April 23, streamed on Twitch, and posted to YouTube.
- A Communication Plan is being created. The main goal is to create consistent, streamlined communications that reach as many people as possible. The community will know what to expect for releases, events, changes, SEPs, and other information. This will empower everyone to collaborate and contribute more effectively.
- Working Groups
- Exist to help make Salt products better and encourage collaboration among core team members and the community
- The only requirement to join is to show up and be interested. Join us!
Sage Robins & Wayne Werner
- Code freeze May 19 with a release June 17
- PRs will be addressed in an internal code jam with plans to hold an additional code jam for community members
- The complete release timeline is available on the wiki: https://github.com/saltstack/community/wiki
- MVPs include a fix for Tornado, upgrading to take advantage of Tornado 5+, and approaches to speeding up test times
Megan Wilhite
- Changelog isn't human readable
- Towncrier is one approach to automating the changelog. It requires a contributor to add a file to the changelog directory, following a specific syntax. This allows automatic creation of changelog at releases.
- Some community members have suggested Conventional Commits
- Create standard commit messages and add in automation to parse those messages and create a changelog file
- Concern is that commit messages aren't already made as human readable
- Discussion will be revisited during the April 23 Open Hour
Wayne Werner
- Slack is going to stop supporting legacy tokens
- Bridge has been set up with Matrix that seems to work "somewhat well so far". It can bridge to Gitter. There are message delays and things to work out still, but the bridge is in place
- Thank you to community members Imran and John for helping Wayne with this project
- Salt News & Updates
- CVE Release & Response
- Towncrier and Changelog
- PR Port Jam
- Open Community Discussion & Questions
Cassandra Faris
- Open SEPs
- Python 3 support: https://github.com/saltstack/salt-enhancement-proposals/pull/26
- Release Label Improvements: https://github.com/saltstack/salt-enhancement-proposals/pull/24
- Slack Bridge to IRC is still in testing
Moe Anderson
- A security vulnerability has been identified that is classified as a high priority (critical)
- Team has been working on making a CVE release available and wants people to know that's coming out next Wednesday, 4/29. It will be titled 3000.2. There will also be support for 2019.2.
- Full details will be exposed soon, in the mean time, we'll be sharing information that guides people to precautionary actions. Following Hardening Salt guide will help ensure that security vulnerabilities are minimized (https://docs.saltstack.com/en/latest/topics/hardening.html#general-hardening-tips)
- A Salt upgrade will be required in order to implement this
Megan Wilhite
- Last week, we discussed Towncrier vs. conventional commits. Goal is to make the changelog more readable. We'll be taking the Towncrier approach
- Towncrier PR will be out and include documentation on what will change when making commits
- Internal PR Merge Jam
- During the internal PR Merge Jam, the core team merged 104 outstanding community PRs into the Sodium release. The PR backlog is now at ~300 items from the ~900 at the beginning of the release
- The team will do one more crack at ports, then have community help with what's left behind and should be part of the sodium
- Community PR Merge Jam
- We will set aside a block of time, identify PRs, assign them out, and work together on them
- Knowing which are higher priorities would be helpful, right now some are taking the approach of working from oldest to newest.
- During the internal jam, we discovered that a number of ports were already merged or made unnecessary since they were superseded by something more recent. It would be helpful for people to look at the backlog and verify whether something still needs ported
- PR Ports Project Board: https://github.com/saltstack/salt/projects/5 - will create a dedicated board for that jam