중요한 버그 수정시 시맨틱 버전 관리


18

현재 공용 사용이 많은 라이브러리를 관리하고 있으며 시맨틱 버전 관리 에 대한 질문이 있습니다. 라이브러리에서 상당히 중요한 부분을 리팩토링하고 싶습니다. 잘못 구현되어 있으며 항상 잘못 구현되었습니다. 그러나이를 수행하는 것은 공개 API의 변경을 의미하며 이는 중요한 결정입니다.

내가 만들고 싶은 변화는 반복자가 사용되는 방법에 관한 것입니다. 현재 사용자는 다음을 수행해야합니다.

while ($element = $iterator->next()) {
   // ...
}

적어도 PHP의 기본 Iterator 인터페이스 에서는 올바르지 않습니다 . 나는 이것을 대체하고 싶다 :

while ($iterator->valid()) {
   $element = $iterator->current();
   // ...
   $iterator->next();
}

이는 다음과 유사합니다.

foreach ($iterator as $element) {
    // ...
}

시맨틱 버전 관리에 대한 Tom의 안내서를 살펴보면 공개 API (즉 , 이전 버전과 호환 되지 않는 변경 사항)에 대한 모든 변경 사항 이 주요 릴리스를 정당화해야한다고 분명히 밝힙니다. 따라서 라이브러리는 1.7.3에서 2.0.0으로 건너 뛸 것입니다. 우리는 하나의 기능이 수정되는 것에 대해서만 이야기하고 있습니다.

나는 결국 2.0.0을 출시 할 계획이 있지만 라이브러리를 완전히 다시 작성하고 수많은 공개 API 변경을 구현했을 때라고 생각했습니다 . 이 리팩토링을 도입하면 메이저 버전 릴리스가 필요합니까? 실제로 어떻게 작동하는지 알 수 없습니다. 1.8.0 또는 1.7.4로 출시하는 것이 더 편안합니다. 누구에게 조언이 있습니까?


이전 버전과의 호환성을 유지하지 못하는 이유는 무엇입니까?
mouviciel

현재이 next()메소드는 현재 요소를 검색하고 내부 포인터를 앞으로 이동시키는 데 사용됩니다. 어느 것이 잘못 되었습니까? next()포인터를 이동하고 current()검색하는 데 사용됩니다 ...
hohner

6
그래서 새 버전에서 사람들의 반환 값에 대해 신경 안 next()이 정말 호환성을 아프게하지 않는, 포인터 이동 만
래칫 괴물

답변:


29

시맨틱 버전 관리를 원하지 않기 때문에 주저하고 "광고 지원 버전 관리"를 작성하려고합니다. 버전 번호 "2.0"은 API를 변경 한 것이 아니라 라이브러리에 새로운 멋진 기능이 많이 있다고 전 세계에 알려줄 것입니다. 괜찮습니다 (많은 소프트웨어 회사 및 / 또는 개발자가 그렇게합니다). IMHO에는 다음과 같은 옵션이 있습니다.

  • 시맨틱 버전 관리를 고수하고 버전 번호를 2.0.0으로 변경해야한다는 사실을 기억하십시오.
  • 버전 관리 체계를 4 개의 숫자로 변경하십시오. "1.1.7.3"은 현재 버전이며, API를 변경 한 후 다음 버전 인 "1.2.0.0"이고 "완전히 새로운 2.x 제품군"의 첫 번째 버전 인 "2.0.0.0"입니다.
  • 수정 프로그램을 이전 버전과 호환 가능하게 만드십시오 (의 기능을 변경하지 말고 및 기능 next만 추가하십시오 ). 그런 다음 "1.8.0"을 다음 버전 번호로 사용할 수 있습니다. 동작 변경 이 정말 중요 하다고 생각되면 2.0.0에서 수행하십시오.validcurrentnext

마지막 옵션만큼 완벽한 솔루션이 될 것입니다. next()계속하는 일을 계속 하도록 요청할 수는 없습니다 . 기능을 올바르게 구현하려면 다르게 작동해야합니다. 따라서 이전 버전과의 호환성을 유지하면 새로운 기능 / 수정 사항이 잘못되어 변경의 전체 지점이 손상됩니다.
hohner

2
세 번째 글 머리 기호 (뒤로 수정 프로그램을 호환 가능하게 함)에서 제안하는 더 넓은 제안은 고려해야 할 좋은 것입니다. 이 특정 경우에는 작동하지 않을 수 있지만 전체 기술을 고려할 가치가 있습니다. 함수는 더 복잡해 지지만 이것은 실행 가능한 경로 일 수 있습니다.

모두에게 감사합니다 : 만약 내가 둘을 받아 들일 수 있다면 나는 할 것입니다. 나는 next()모든 새로운 기능을 수행하기 위해 새로운 방법을 해킹하고 이전 버전과 호환되도록하는 데 필요한 것을 해냈습니다. 이와 같은 새로운 기능을 손상시켜야하는 것은 끔찍한 일이지만, 호.
hohner

10
@ hohner : 이제는 이전 동작을 더 이상 사용되지 않는 것으로 문서화 할 때이므로 2.0.0에서 제거 할 수 있습니다.
Jan Fabry

7

시맨틱 버전 관리에 대한 Tom의 가이드를 고수하십시오.

퍼블릭 API에 대한 중대한 변경 은 다음 두 지점 중 하나에서 수행 해야합니다 .

  1. 메이저 릴리스 업데이트

그건 그렇고, 내 투표는 첫 번째입니다. 그러나 나는 그것이 사소한 일에만 적합하다는 것을 인정합니다.

문제는 이전 버전과의 호환성을 유지하고 이전 API 사용자에게 문제가되지 않도록하는 것입니다.

본질적으로, 변경 사항을 모르는 사용자를 위해 인덱싱 오류가 발생합니다. 이와 같이 변경하면 모든 사용자가 다음을 수행해야합니다.

  1. 새로운 접근 방식을 사용하도록 수정 프로그램을 코딩하십시오.
  2. 수정 사항을 확인하고 아무 것도 깨지지 않았는지 확인하십시오.
  3. 최종 사용자에게 제품의 새로운 릴리스를 제공

특히 이와 같은 변경 사항을 확인하기 위해 테스트 사례가있는 프로젝트가 몇 개인 지 고려할 때 많은 노력을 기울일 수 있습니다. 설치를 업데이트해야하는 사용자의 다운 스트림 사용자 수를 고려할 때 많은 노력이 필요합니다.

이 작은 것을 위해, 나는 그것을 놓아두고 귀찮게하지 않을 것입니다.
그것이 실제로 당신을 귀찮게한다면 (겉으로는 그렇지 않거나 묻지 않았을 것입니다), 나는 다음을 할 것입니다.

  1. 코드 트리에서 v2.0.0 분기를 만듭니다.
  2. v2.0.0 브랜치에 처음으로 기여하십시오.
  3. Release Notes변경이 다가오고 있음을 미리 방송 하여 미리보기를 보냅니다.

그런 다음 버전 번호를 새로운 주요 릴리스로 업그레이드하는 것을 정당화하는 다른 것들을 축적하는 데 시간이 걸리므로 인내심을 가지십시오. 고급 알림 (3 부)은 최종 사용자로부터 피드백을받을 수있는 시간을 제공하여 변경이 미치는 영향의 정도를 확인합니다.


다른 해결책은 원하는 방식으로 작동하는 새로운 기능을 추가하는 것입니다.

그렇다면 수정을 제공하기 위해 foo()작성 fooCorrect()하고 이전 버전과의 호환성을 완전히 유지하십시오. 그리고 어떤 시점에서 foo()다른 사람들에게 사용하지 말라고 알리기 위해 더 이상 사용하지 않을 수 있습니다.

문제는 당신이 찾을 수 있다는이 뭔가 다른 내에서 fooCorrect()어떤 필요로 그것의 갱신을 당신이와 끝까지 fooCorrectedCorrect()또는 다른 바보 넌센스.

당신이 경우 정말로 원하는 이 지금은 고정이 다른 방법은 아마도 최선의 경로입니다. API를 사용하기가 더 어려워 지므로이 방법으로 많은 추가 기능을 작성하는 것에주의하십시오. 이러한 인식은 이러한 유형의 문제 중 최악을 방지하기에 충분할 수 있습니다.

그러나 이것은 작은 것을 고려하기위한 "가장 나쁜"접근 방법 일 수 있습니다.


동의합니다. 내가 직면하는 문제는 v2.0.0의 라이브러리를 완전히 다시 작성하고 싶다는 것입니다 (수정해야 할 많은 문제 가 있기 때문에 ). 그래서이 큰 변화의 기초를 이루는 반복자와 같은 작은 변화를 원하지 않습니다. 내 옵션은 다음과 같습니다.이 버그를 무시하거나 버그를 수정하여 새로운 주요 버전으로 넣습니까?
hohner

@hohner-새로운 기능을 만드는 대안 접근 방식을 제공하기 위해 답변이 업데이트되었습니다. 새, 비슷한 이름의 많은 기능이 있음을 염두에 거의 API를 자체를 변경하는 등 나쁜한다.

3
@ hohner :이 경우 일관되게 잘못> 일관성이 없습니다. 행동은 여전히 ​​기능하며, 관용적이지 않습니다. 이 변경을 수행하면 클라이언트 코드 가 손상 되는 것을 고려하십시오 . 경고 없이이 작업을 수행하는 것은 감사하지 않습니다.
Phoshi

@ GlenH7이 경우 다른 이름의 방법을 사용하면 작동하지 않습니다. PHP의 기본 반복자는 이러한 메소드에 의존합니다 (예 : next()아닌 nextCorrect()). next ()를 수정할 수 있는지 확인하여 이전 버전과 호환되며 Iterator인터페이스를 구현할 때 작동합니다 .
hohner

1
@Phoshi 당신은 자리에 있습니다-나는 완전히 동의합니다. 이제 불가능한 코드를 작성해볼 시간이다 : D
hohner
당사 사이트를 사용함과 동시에 당사의 쿠키 정책개인정보 보호정책을 읽고 이해하였음을 인정하는 것으로 간주합니다.
Licensed under cc by-sa 3.0 with attribution required.