Skip to content

Commit 305343b

Browse files
committed
Call it inlining (not vendoring) in readme
1 parent a87cb23 commit 305343b

1 file changed

Lines changed: 17 additions & 11 deletions

File tree

lib/membrane/README.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
1-
# Vendored Membrane Library
1+
# Inlined Membrane Library
22

3-
This directory contains the Membrane validation library vendored from:
3+
This directory contains the Membrane validation library inlined from the archived CloudFoundry project:
44
https://github.com/cloudfoundry/membrane
55

66
**License:** Apache License 2.0
77
**Copyright:** (c) 2013 Pivotal Software Inc.
8-
**Vendored version:** 1.1.0
8+
**Inlined version:** 1.1.0
9+
**Upstream status:** Archived in 2022 (last commit: 2014-04-03)
910

10-
## Vendoring Details
11+
## Inlining Details
1112

1213
**Source commit:**
1314
- Commit: `1eeadcf64c20d94e61379707c20b16d3d9a26d87`
@@ -16,26 +17,31 @@ https://github.com/cloudfoundry/membrane
1617
- Message: Add Code Climate badge to README.
1718
- Tag: scotty_09012012-23-g1eeadcf
1819

19-
The upstream LICENSE and NOTICE files are included alongside the vendored code
20+
The upstream LICENSE and NOTICE files are included alongside the inlined code
2021
in this directory (copied verbatim from the upstream repository).
2122
Source: https://github.com/cloudfoundry/membrane
2223

23-
This code is vendored (inlined) into Cloud Controller NG to remove
24-
the external gem dependency.
24+
This code is inlined into Cloud Controller NG because:
25+
- The upstream repository was archived in 2022 with no updates since 2014
26+
- Removes external gem dependency
27+
- Allows CCNG to maintain and modernize the code for Ruby 3.3+ compatibility
28+
- Enables removal of unused features specific to CCNG's needs
2529

2630
## Detailed Modifications from Upstream
2731

2832
All modifications are documented here for license compliance and auditability.
29-
The upstream repository has been inactive since 2014-04-03.
33+
The upstream repository was archived in 2022 with the last commit from 2014.
34+
Since this is an inlined copy (not a vendored dependency), CCNG maintains
35+
and modernizes the code for Ruby 3.3+ compatibility and removes unused features.
3036

3137
### 1. New Files Created
3238

3339
#### `lib/membrane.rb` (Shim/Entrypoint)
3440
- **Type:** New file
35-
- **Purpose:** Makes `require "membrane"` load vendored code instead of gem
41+
- **Purpose:** Makes `require "membrane"` load inlined code instead of gem
3642
- **Content:** Header comment + four require statements
3743
- **Changes from upstream:**
38-
- Added 3-line header comment documenting vendoring
44+
- Added 3-line header comment documenting inlining
3945
- Changed double quotes to single quotes (CCNG style)
4046

4147
### 2. Ruby 3.3 Modernization (All Files)
@@ -356,7 +362,7 @@ bundle exec rspec spec/unit/lib/vendored_membrane_spec.rb
356362

357363
## Maintenance Notes
358364

359-
Since the upstream repository has been inactive since 2014 and is effectively abandoned, these modifications bring the code to modern Ruby 3.3+ standards while maintaining full compatibility. All changes are purely stylistic, performance-related, or code quality improvements - no logic or behavior has been altered.
365+
Since the upstream repository was archived in 2022 (with the last commit from 2014), this inlined copy is now maintained by CCNG. These modifications bring the code to modern Ruby 3.3+ standards while maintaining compatibility with CCNG's usage patterns. All changes are for modernization, performance, security, or removal of unused features - no logic changes to actively used functionality.
360366

361367
The comprehensive test suite (13 spec files from upstream + 1 integration spec) ensures that all functionality continues to work correctly and provides confidence for future modifications.
362368

0 commit comments

Comments
 (0)